Skip to content
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

Closes #51 : Added index.d.ts + documentation for javascript and typescript #59

Merged
merged 9 commits into from
Feb 25, 2021

Conversation

iArmanKarimi
Copy link
Contributor

Closes #51 : Added index.d.ts + documentation for Javascript and Typescript

Better example in doc
hid callback_type type
Better example in doc
js example instead of ts
Provided typescript examples
also a getting-cow-names example was missing.
doc update
Copy link
Contributor

@lachieh lachieh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good to be, aside from a few the y and w being switched in some of the examples. I'm not the owner but I have confirmed that this file works as expected. I appreciate the updated readme with examples too.

@piuccio if you're good with the README.md changes, this is good from a TS perspective.

index.d.ts Outdated Show resolved Hide resolved
Comment on lines +135 to +136
* - #### `w` : youthful
* - #### `y` : wired
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* - #### `w` : youthful
* - #### `y` : wired
* - #### `w` : wired
* - #### `y` : youthful

index.js Outdated Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.d.ts Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can you consider writing type.d.ts
3 participants