Type alias CommitParams

CommitParams: {
    dir: string;
    fs: FsClient;
    message: string;
    author?: Author;
    cache?: Cache;
    committer?: Author;
    dryRun?: boolean;
    gitdir?: string;
    noUpdateBranch?: boolean;
    onSign?: SignCallback;
    parent?: string[];
    ref?: string;
    signingKey?: string;
    tree?: string;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system implementation.

  • message: string

    The commit message to use.

  • Optional author?: Author

    The details about the author.

  • Optional cache?: Cache

    a cache object.

  • Optional committer?: Author

    The details about the commit committer, in the same format as the author parameter. If not specified, the author details are used.

  • Optional dryRun?: boolean

    If true, simulates making a commit so you can test whether it would succeed. Implies noUpdateBranch.

  • Optional gitdir?: string

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

  • Optional noUpdateBranch?: boolean

    If true, does not update the branch pointer after creating the commit.

  • Optional onSign?: SignCallback

    A PGP signing implementation.

  • Optional parent?: string[]

    The SHA-1 object ids of the commits to use as parents. If not specified, the commit pointed to by ref is used.

  • Optional ref?: string

    The fully expanded name of the branch to commit to. Default is the current branch pointed to by HEAD. (TODO: fix it so it can expand branch names without throwing if the branch doesn't exist yet).

  • Optional signingKey?: string

    Sign the tag object using this private PGP key.

  • Optional tree?: string

    The SHA-1 object id of the tree to use. If not specified, a new tree object is created from the current git index.

Settings

Member Visibility

Theme

Generated using TypeDoc