Type alias LogParams

LogParams: {
    dir: string;
    fs: FsClient;
    cache?: Cache;
    depth?: number;
    filepath?: string;
    follow?: boolean;
    force?: boolean;
    gitdir?: string;
    ref?: string;
    since?: Date;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system client.

  • Optional cache?: Cache

    A cache object.

  • Optional depth?: number

    Limit the number of commits returned. No limit by default.

  • Optional filepath?: string

    Get the commit for the filepath only.

  • Optional follow?: boolean

    Continue listing the history of a file beyond renames (works only for a single file, default: false).

  • Optional force?: boolean

    Do not throw error if filepath does not exist (works only for a single file, default: false).

  • Optional gitdir?: string

    The git directory path (default: {dir}/.git).

  • Optional ref?: string

    The commit to begin walking backwards through the history from (default: HEAD).

  • Optional since?: Date

    Return history newer than the given date. Can be combined with depth to get whichever is shorter.

Settings

Member Visibility

Theme

Generated using TypeDoc