Interface ICommit

interface ICommit {
    getAuthor(): Author | null;
    getDescription(): string;
    getId(): string;
    getIntents(): Readonly<Record<string, any>>;
    getMeta(): Readonly<Record<string, string>>;
    getOperation(): Readonly<Operation>;
    getTimestamp(): number;
}

Index

Methods

getAuthor getDescription getId getIntents getMeta getOperation getTimestamp

Methods

getAuthor

getAuthor(): Author | null

The author of the commit, or null when unattributed.

Returns Author | null

getDescription

getDescription(): string

A human readable description of the commit.

Returns string

getId

getId(): string

Returns the unique identifier for the commit.

Returns string

getIntents

getIntents(): Readonly<Record<string, any>>

The intents recorded on the commit, keyed by name. Empty if it recorded none.

Returns Readonly<Record<string, any>>

See
ITransaction.setIntent

getMeta

getMeta(): Readonly<Record<string, string>>

Additional meta information set during open and close.

Returns Readonly<Record<string, string>>

getOperation

getOperation(): Readonly<Operation>

Returns the operation that was used to create the commit.

Returns Readonly<Operation>

Remarks
It is possible that a batch operation was used to create the commit.

getTimestamp

getTimestamp(): number

The time the commit was created.

Returns number