Class CommitBuilder

A Commit without its signature, signer and timestamp

Hierarchy

  • CommitBuilder

Constructors

constructor

Properties

_destroy? _previousCommit? _push _remove _set _subject

Accessors

destroy previousCommit push remove set subject

Methods

addPushAction addRemoveAction addSetAction clone hasUnsavedChanges removeRemoveAction setDestroy setPreviousCommit setSubject sign signAt toPlainObject

Constructors

constructor

Properties

Private Optional _destroy

_destroy?: any

Private Optional _previousCommit

_previousCommit?: any

Private _push

_push: any

Private _remove

_remove: any

Private _set

_set: any

Private _subject

_subject: any

Accessors

destroy

  • get destroy(): undefined | boolean

  • Returns undefined | boolean

previousCommit

  • get previousCommit(): undefined | string

  • Returns undefined | string

push

  • get push(): Map<string, Set<JSONValue>>

  • Returns Map<string, Set<JSONValue>>

remove

  • get remove(): Set<string>

  • Returns Set<string>

set

  • get set(): Map<string, JSONValue>

  • Returns Map<string, JSONValue>

subject

  • get subject(): string

  • Returns string

Methods

addPushAction

addRemoveAction

  • Parameters

    • property: string

    Returns CommitBuilder

addSetAction

clone

  • Creates a clone of the CommitBuilder. This is required, because I want to prevent any adjustments to the CommitBuilder while signing, as this could cause race conditions with wrong signatures

    Returns CommitBuilder

hasUnsavedChanges

  • Returns true if the CommitBuilder has non-empty changes (set, remove, destroy)

    Returns boolean

removeRemoveAction

  • Parameters

    • property: string

    Returns CommitBuilder

setDestroy

  • Parameters

    • destroy: boolean

    Returns CommitBuilder

setPreviousCommit

  • Set the URL of the Commit that was previously (last) applied. The value of this should probably be the lastCommit of the Resource.

    Parameters

    • prev: string

    Returns CommitBuilder

setSubject

  • Parameters

    • subject: string

    Returns CommitBuilder

sign

  • Signs the commit using the privateKey of the Agent, and returns a full Commit which is ready to be sent to an Atomic-Server /commit endpoint.

    Parameters

    • privateKey: string
    • agentSubject: string

    Returns Promise<Commit>

signAt

  • Creates a signature for a Commit using the private Key of some Agent.

    Parameters

    • agent: string

      Subject URL of the Agent signing the Commit

    • privateKey: string

      Base64 serialized private key matching the public key of the agent

    • createdAt: number

      Time of signing in millisecons since unix epoch

    Returns Promise<Commit>

toPlainObject

Settings

Member Visibility

Theme

Generated using TypeDoc