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.

Sign up for GitHub

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

Jump to bottom

Add some proper API documentation #33

Closed
Tyriar opened this issue Jan 20, 2017 · 6 comments
Closed

Add some proper API documentation #33

Tyriar opened this issue Jan 20, 2017 · 6 comments
Labels
enhancement

Comments

@Tyriar
Copy link
Member

Tyriar commented Jan 20, 2017

No description provided.

@eddiewang
Copy link

is this forked from another project? trying to look for some helpful docs here.

@Tyriar
Copy link
Member Author

Tyriar commented Mar 28, 2017

@eddiewang this is forked from the no longer maintained chjj/pty.js. This issue is mainly about surfacing what's private and what's public API. For most use cases the examples cover everything.

@Tyriar
Copy link
Member Author

Tyriar commented Jul 10, 2017

There is much richer type information in 0.6.9:

image

@Tyriar
Copy link
Member Author

Tyriar commented Apr 9, 2018

Added typings now, the API surface got a lot smaller as I only added a handful of APIs. Will add more as people request them.

@Tyriar Tyriar closed this as completed Apr 9, 2018
@raxod502
Copy link

raxod502 commented Jul 31, 2020 •
edited
Loading

Could this file be linked from the README? Or even better, could some HTML docs be generated? I was still under the impression that this project was undocumented until I found this issue, despite using the library several times.

@Tyriar
Copy link
Member Author

Tyriar commented Jul 31, 2020

@raxod502 good feedback, added an API section to the readme. HTML docs seem overkill imo.

daniel-brenot added a commit to daniel-brenot/node-pty that referenced this issue Oct 30, 2021
@daniel-brenot
Add node-gyp to devDependencies fixes microsoft#33
f108cca
@Tyriar Tyriar mentioned this issue Dec 8, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@eddiewang @Tyriar @raxod502