notegit: Add 'start' method to Commit history() return type (#30608)

This commit is contained in:
jonmellman
2018-11-18 19:45:56 +01:00
committed by Pranav Senthilnathan
parent ec44d45205
commit 71abbf7c6d

View File

@@ -9,6 +9,10 @@ import { Tree } from './tree';
import { TreeEntry } from './tree-entry';
import { Diff } from './diff';
export interface HistoryEventEmitter extends EventEmitter {
start(): void;
}
export class Commit {
static create(repo: Repository, updateRef: string, author: Signature, committer: Signature, messageEncoding: string, message: string, tree: Tree, parentCount: number, parents: any[]): Oid;
static createV(id: Oid, repo: Repository, updateRef: string, author: Signature, committer: Signature, messageEncoding: string, message: string, tree: Tree, parentCount: number): number;
@@ -75,11 +79,11 @@ export class Commit {
/**
* Walk the history from this commit backwards.
* An EventEmitter is returned that will emit a "commit" event for each commit in the history, and one "end"
* event when the walk is completed. Don't forget to call start() on the returned event.
* event when the walk is completed. Don't forget to call start() on the returned EventEmitter.
*
*
*/
history(): EventEmitter;
history(): HistoryEventEmitter;
/**
* Retrieve the commit's parents as commit objects.
*