chore: add TypeScript typings file #926

watson · 2019-03-16T21:23:45Z

Closes #586

Checklist

Implement code
Fix TODO's
Add tests
Add TypeScript usage docs

watson · 2019-03-17T08:49:15Z

I'm obviously doing something wrong with the shared function definitions. They have different icons in VS Code compared to the ones defined inline (e.g. addTags vs. addFilter):

delvedor

Overall LGTM :)
You need to add some testing as well, here and here you can find how I'm testing the types in the js client.

/cc @timroes, he helped me so much while I was writing the type definitions for the client :)

index.d.ts

start.d.ts

watson · 2019-03-17T14:36:24Z

I asked on SO about how to fix the issue with the shared class methods: https://stackoverflow.com/questions/55208211/how-to-share-a-typescript-function-definition-between-two-classes

watson · 2019-03-17T16:10:44Z

🤔 I just realized that this "feature" makes .d.ts files a bit annoying for users: microsoft/vscode#68782

index.d.ts

bmorelli25

Docs LGTM

watson · 2019-03-25T17:07:12Z

testing some hooks... please ignore 😎

nik9000 · 2019-03-25T17:33:22Z

I'm looking at the docs-build failure. I believe it is safe to ignore but I'll track it down!

nik9000 · 2019-03-25T17:38:06Z

I'm looking at the docs-build failure. I believe it is safe to ignore but I'll track it down!

I've tracked down the issue and will submit a PR to fix it to the infra repo. Sorry for the trouble. Thanks for being my first victims!

The removed versions all depend on apollo-upload-server@5.0.0 which is broken because of a missing dependency: core-js The reason why it worked before was because one of our other devDependencies had the correct core-js dependency. With the added dev-dependency for Babel, this core-js dependency have now been updated to a version unsupported by apollo-upload-server, and so the tests for apollo-server-express <2.0.5 now fails.

nik9000 · 2019-03-25T17:41:50Z

@elasticmachcine, run docs build.

nik9000 · 2019-03-25T17:58:58Z

@elasticmachine, run docs build.

nik9000 · 2019-03-25T18:10:03Z

I'm looking at the docs-build failure. I believe it is safe to ignore but I'll track it down!

I've tracked down the issue and will submit a PR to fix it to the infra repo. Sorry for the trouble. Thanks for being my first victims!

Fixed!

watson · 2019-03-25T19:55:48Z

jenkins run tests please

spalger · 2019-04-23T20:24:57Z

Thank you!!! 🌮

smhmayboudi · 2020-02-15T01:41:17Z

I think it is better to use the npm package definitions instead of writing them.

import AwsLambda from "aws-lambda";
import Connect from "connect";

apm-agent-nodejs/index.d.ts

Line 327 in c56f894

// Inlined from @types/aws-lambda - start

apm-agent-nodejs/index.d.ts

Line 389 in c56f894

// Inlined from @types/connect - start

smhmayboudi · 2020-02-15T01:44:28Z

I copy and paste this file to my project. Is there another way to reach the interfaces and class definitions?

smhmayboudi · 2020-02-15T01:47:22Z

I read the docs and find out logUncaughtExceptions is not defined in AgentConfigOptions. Would you please fix it.

watson added the [zube]: In Progress label Mar 16, 2019

watson self-assigned this Mar 16, 2019

watson force-pushed the typescript-typings branch from 996e435 to 2265db6 Compare March 16, 2019 21:28

watson mentioned this pull request Mar 16, 2019

Added initial type definitions for usage in Typescript #591

Closed

2 tasks

watson force-pushed the typescript-typings branch from 2265db6 to 4a20c85 Compare March 16, 2019 21:36

watson requested a review from Qard March 16, 2019 21:45

chore: add TypeScript typings file

ce48671

watson force-pushed the typescript-typings branch from 4a20c85 to ce48671 Compare March 16, 2019 21:45

watson added 4 commits March 16, 2019 23:20

fix: improve TypeScript thingys

1a4a5c1

fix: no need for enums I guess

b08ae17

fix(typescript): fix the Logger interface

59f379c

refactor(typescript): tidy up

b03e257

watson requested review from delvedor and sorenlouv March 16, 2019 22:51

Qard previously approved these changes Mar 16, 2019

View reviewed changes

fix(typescript): correct export

1b634c0

watson dismissed Qard’s stale review via 1b634c0 March 17, 2019 08:45

watson added 7 commits March 17, 2019 09:54

fix(ts): filter functions don't need an explicit return

a696aa5

fix(ts): fix agent.middleware.connect type

d55d3eb

fix(ts): improve comments

05b93c9

fix(ts): fix start.d.ts export

9f96c6c

fix(ts): work on TODOs

0e43bfc

fix(ts): improve tag typing

188ac2e

fix(ts): allow calling captureError(err, callback)

81d3727

delvedor reviewed Mar 17, 2019

View reviewed changes

index.d.ts Show resolved Hide resolved

start.d.ts Outdated Show resolved Hide resolved

Qard reviewed Mar 18, 2019

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

index.d.ts Outdated Show resolved Hide resolved

index.d.ts Outdated Show resolved Hide resolved

fix(ts): tidy up

b8b4741

bmorelli25 previously approved these changes Mar 25, 2019

View reviewed changes

watson dismissed stale reviews from bmorelli25 and vigneshshanmugam via a4a1e4c March 25, 2019 16:44

watson force-pushed the typescript-typings branch from a4a1e4c to fe6211b Compare March 25, 2019 17:18

Qard previously approved these changes Mar 25, 2019

View reviewed changes

watson dismissed Qard’s stale review via 1b72ef6 March 25, 2019 17:42

watson force-pushed the typescript-typings branch from fe6211b to 1b72ef6 Compare March 25, 2019 17:42

watson added 3 commits March 25, 2019 22:21

Merge branch 'master' into typescript-typings

1ea56e2

fix(ts): move inlined types into namespaces

41993e6

fix(ts): add types for new patch functions

cd091e6

watson requested a review from Qard March 25, 2019 22:05

Qard approved these changes Mar 26, 2019

View reviewed changes

watson merged commit 1146bfe into elastic:master Mar 26, 2019

zube bot added [zube]: Done and removed [zube]: In Review labels Mar 26, 2019

watson deleted the typescript-typings branch March 26, 2019 08:03

watson mentioned this pull request Mar 26, 2019

Remove elastic-apm-node DefinitelyTyped/DefinitelyTyped#34243

Merged

watson mentioned this pull request Apr 3, 2019

Typescript - Unable to export Agent#lambda(...) from client library due to absence of exported inline AwsLambda.Context. #977

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add TypeScript typings file #926

chore: add TypeScript typings file #926

watson commented Mar 16, 2019 •

edited by zube bot

Loading

watson commented Mar 17, 2019

delvedor left a comment

watson commented Mar 17, 2019

watson commented Mar 17, 2019

bmorelli25 left a comment

watson commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

watson commented Mar 25, 2019

spalger commented Apr 23, 2019

smhmayboudi commented Feb 15, 2020

smhmayboudi commented Feb 15, 2020

smhmayboudi commented Feb 15, 2020

chore: add TypeScript typings file #926

chore: add TypeScript typings file #926

Conversation

watson commented Mar 16, 2019 • edited by zube bot Loading

Checklist

watson commented Mar 17, 2019

delvedor left a comment

Choose a reason for hiding this comment

watson commented Mar 17, 2019

watson commented Mar 17, 2019

bmorelli25 left a comment

Choose a reason for hiding this comment

watson commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

nik9000 commented Mar 25, 2019

watson commented Mar 25, 2019

spalger commented Apr 23, 2019

smhmayboudi commented Feb 15, 2020

smhmayboudi commented Feb 15, 2020

smhmayboudi commented Feb 15, 2020

watson commented Mar 16, 2019 •

edited by zube bot

Loading