Type alias BranchParams

BranchParams: {
    dir: string;
    fs: FsClient;
    ref: string;
    checkout?: boolean;
    force?: boolean;
    gitdir?: string;
    startPoint?: string;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system implementation.

  • ref: string

    What to name the branch.

  • Optional checkout?: boolean

    Update HEAD to point at the newly created branch.

  • Optional force?: boolean

    Instead of throwing an error if a branched named ref already exists, overwrite the existing branch.

  • Optional gitdir?: string

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

  • Optional startPoint?: string

    What oid to use as the start point. Accepts a symbolic ref (default: HEAD).

Settings

Member Visibility

Theme

Generated using TypeDoc