Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
[Documentation] Commit.history() -> EventEmitter, start function missing #1571
Comments
|
Fair enough. |
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
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.