@types/current-git-branch/README.md

TypeScript definitions for current-git-branch

# Installation
> `npm install --save @types/current-git-branch`

# Summary
This package contains type definitions for current-git-branch (https://www.npmjs.com/package/current-git-branch).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/current-git-branch.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/current-git-branch/index.d.ts)
````ts
declare namespace CurrentGitBranch {
    type CurrentGitBranchOptions = CurrentGitBranchOptionsObject | string[] | string;
    type CurrentGitBranchResult = string | false;

    interface CurrentGitBranchOptionsObject {
        altPath?: string | undefined;
        branchOptions?: string | undefined;
    }
}

declare function CurrentGitBranch(
    args?: CurrentGitBranch.CurrentGitBranchOptions,
): CurrentGitBranch.CurrentGitBranchResult;

export = CurrentGitBranch;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Max Boguslavskiy](https://github.com/maxbogus).