@types/nodegit/rev-walk.d.ts

TypeScript definitions for nodegit

import { Commit } from "./commit";
import { Diff } from "./diff";
import { Oid } from "./oid";
import { Repository } from "./repository";

export namespace Revwalk {
    const enum SORT {
        NONE = 0,
        TOPOLOGICAL = 1,
        TIME = 2,
        REVERSE = 4,
    }
    interface HistoryEntry {
        commit: Commit;
        status: Diff.DELTA;
        newName: string;
        oldName: string;
    }
}

export class Revwalk {
    static create(repo: Repository): Revwalk;

    hide(commitId: Oid): number;
    hideGlob(glob: string): number;
    hideHead(): number;
    hideRef(refname: string): number;
    next(): Promise<Oid>;
    push(id: Oid): number;
    pushGlob(glob: string): number;
    pushHead(): number;
    pushRange(range: string): number;
    pushRef(refname: string): number;
    repository(): Repository;

    reset(): void;

    simplifyFirstParent(): void;
    /**
     * Set the sort order for the revwalk. This function takes variable arguments like revwalk.sorting(NodeGit.RevWalk.Topological, NodeGit.RevWalk.Reverse).
     */
    sorting(...sort: number[]): void;
    commitWalk(maxCount: number): Promise<Commit[]>;
    fastWalk(maxCount: number): Promise<Oid[]>;
    fileHistoryWalk(filePath: string, maxCount: number): Promise<Revwalk.HistoryEntry[]>;
    /**
     * Walk the history from the given oid. The callback is invoked for each commit; When the walk is over, the callback is invoked with (null, null).
     */
    walk(oid: Oid, callback?: Function): Commit;
    /**
     * Walk the history grabbing commits until the checkFn called with the current commit returns false.
     */
    getCommitsUntil(checkFn: Function): Promise<Commit[]>;
    getCommits(count: number): Promise<Commit[]>;
}