-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TypeScript definitions #308
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much @antonvasin, this will definitely be appreciated!
I did my best to capture any discrepancies, combing through the code. As you can see, the docs are not super comprehensive, unfortunately.
Do you have bandwidth to address the changes?
Oh, as far as your questions:
|
Thanks for the feedback.
Sure, I'll look into them. |
see honeycombio/libhoney-js#90 for a similar effort. |
I've updated this MR with comments above. Took me a while, sorry. |
@antonvasin same here, took a while to come back to this. The changes look good to me 👍 Do you mind resolving the package conflict? |
As mentioned in #126.
When writing I've used API.md as a reference.
Things I'm not sure about:
MetadataContext
seems to deserve stricter type thanany
type
andinterface
syntax. Some use both, some use only one, so those things can be very opinionated. Since the project itself is written in plain JS I've tried to write it “default” wayrequire
since we're not using it in TS projects at all