Constructors
constructor
new Commit( gitDir: string , hash: string , data: string , _packs?: Packs ) : Commit
Parameters
gitDir: string
hash: string
data: string
Optional _packs: Packs
Properties
parentHashes
parentHashes: string []
Accessors
baseParentHash
get baseParentHash( ) : string
hasParents
get hasParents( ) : boolean
isMergeCommit
get isMergeCommit( ) : boolean
mergedParentHashes
get mergedParentHashes( ) : string []
Methods
walk
walk( parentHash?: number | string ) : Promise < Commit >
Parameters
Default value parentHash: number | string = 0
Returns Promise < Commit >
walkSync
walkSync( parentHash?: number | string ) : Commit
Parameters
Default value parentHash: number | string = 0
Static readCommit
readCommit( gitDir: string , hash: string , packs?: Packs ) : Promise < Commit >
Parameters
gitDir: string
hash: string
Optional packs: Packs
Returns Promise < Commit >
Static readCommitSync
readCommitSync( gitDir: string , hash: string , packs?: Packs ) : Commit
Parameters
gitDir: string
hash: string
Optional packs: Packs
Legend
Module Object literal Variable Function Function with type parameter Index signature Type alias
Enumeration Enumeration member Property Method
Interface Interface with type parameter Constructor Property Method Index signature
Class Class with type parameter Constructor Property Method Accessor Index signature
Inherited constructor Inherited property Inherited method Inherited accessor
Protected property Protected method Protected accessor
Private property Private method Private accessor
Static property Static method
Get parent commit by a parent hash.
// default is the baseParentHash. let parentCommit = await commit.walk(); // or set a parent hash manually. parentCommit = await commit.walk(commit.parentHash[1]); // same mean parentCommit = await commit.walk(1);