Class AnnotatedCommit

Represents an annotated commit object.

record

Hierarchy

AnnotatedCommit

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new AnnotatedCommit(): AnnotatedCommit

Returns AnnotatedCommit

Properties

Static name

name: string

Methods

getId

getId(): OId

- Defined in Ggit-1.0.d.ts:5571
Gets the commit ID that the given annotated_commit refs to.

Returns OId

ref

ref(): AnnotatedCommit

- Defined in Ggit-1.0.d.ts:5576
Atomically increments the reference count of annotated_commit by one. This function is MT-safe and may be called from any thread.

Returns AnnotatedCommit

unref

unref(): void

- Defined in Ggit-1.0.d.ts:5581
Atomically decrements the reference count of annotated_commit by one. If the reference count drops to 0, annotated_commit is freed.

Returns void

Static newFromRef

newFromRef(repository: Ggit.Repository, ref: Ggit.Ref): AnnotatedCommit

- Defined in Ggit-1.0.d.ts:5602
Create a GgitAnnotatedCommit from the given reference

Parameters
- repository: Ggit.Repository
  
  the repository
- ref: Ggit.Ref
  
  the reference to use to lookup the git_annotated_commit
Returns AnnotatedCommit