Class BranchEnumerator

Represents a branch enumerator.

record

Hierarchy

BranchEnumerator

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new BranchEnumerator(): BranchEnumerator

Returns BranchEnumerator

Properties

Static name

name: string

Methods

get

get(): Ggit.Ref

- Defined in Ggit-1.0.d.ts:5829
Returns the currently being enumerated branch, or %NULL. Note that the returned GgitRef will be of type GgitBranch if the ref represents a local branch.

Returns Ggit.Ref

iterator

iterator(): BranchEnumerator

- Defined in Ggit-1.0.d.ts:5833
Get an iterator for the enumerator.

Returns BranchEnumerator

next

next(): boolean

- Defined in Ggit-1.0.d.ts:5837
Move the enumerator to the next branch.

Returns boolean

ref

ref(): BranchEnumerator

- Defined in Ggit-1.0.d.ts:5838
Returns BranchEnumerator

unref

unref(): void

- Defined in Ggit-1.0.d.ts:5839
Returns void