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

[Documentation] Commit.history() -> EventEmitter, start function missing #1571

Open
gins3000 opened this issue Oct 23, 2018 · 1 comment
Open

Comments

@gins3000
Copy link

@gins3000 gins3000 commented Oct 23, 2018

Hi, I am using nodegit in a Typescript project, and came across a typings mismatch for which I filed an issue over at DefinitelyTyped: DefinitelyTyped/DefinitelyTyped#29969

Commit.history()'s documentation says Don't forget to call start() on the returned event. and the return type is EventEmitter.

EventEmitter does not have a function called start().

Turns out the documentation at https://www.nodegit.org/api/commit/#history seems to be mismatching already.

As can be seen in the nodejs docs (https://nodejs.org/api/events.html#events_class_eventemitter) there is no start function on EventEmitter.

Perhaps it would be good to review what Commit.history() actually returns and update its return type in the documentation, so that the types can also be updated without conflicting with the official documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.