Type alias CurrentBranchParams

CurrentBranchParams: {
    dir: string;
    fs: FsClient;
    fullname?: boolean;
    gitdir?: string;
    test?: boolean;
}

Type declaration

  • dir: string

    The working tree directory path.

  • fs: FsClient

    A file system implementation.

  • Optional fullname?: boolean

    Return the full path (e.g. "refs/heads/main") instead of the abbreviated form.

  • Optional gitdir?: string

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

  • Optional test?: boolean

    If the current branch doesn't actually exist (such as right after git init) then return undefined.

Generated using TypeDoc