Class CommitBuilder

A Commit without its signature, signer and timestamp

Hierarchy

CommitBuilder

Index

Constructors

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

new CommitBuilder(subject: string, base?: CommitBuilderBase): CommitBuilder
Removes any query parameters from the Subject
Parameters
- subject: string
- base: CommitBuilderBase = {}
Returns CommitBuilder
- Defined in lib/src/commit.ts:68

Properties

`Private` `Optional` _destroy

_destroy?: boolean

`Private` `Optional` _previousCommit

_previousCommit?: string

`Private` _push

_push: Map<string, Set<JSONValue>>

`Private` _remove

_remove: Set<string>

`Private` _set

_set: Map<string, JSONValue>

`Private` _subject

_subject: string

Accessors

destroy

get destroy(): undefined | boolean
Returns undefined | boolean
- Defined in lib/src/commit.ts:93

previousCommit

get previousCommit(): undefined | string
Returns undefined | string
- Defined in lib/src/commit.ts:97

push

get push(): Map<string, Set<JSONValue>>
Returns Map<string, Set<JSONValue>>
- Defined in lib/src/commit.ts:85

remove

get remove(): Set<string>
Returns Set<string>
- Defined in lib/src/commit.ts:89

set

get set(): Map<string, JSONValue>
Returns Map<string, JSONValue>
- Defined in lib/src/commit.ts:81

subject

get subject(): string
Returns string
- Defined in lib/src/commit.ts:77

Methods

addPushAction

addPushAction(property: string, ...values: JSONArray): CommitBuilder
Parameters
- property: string
- Rest ...values: JSONArray
Returns CommitBuilder
- Defined in lib/src/commit.ts:108

addRemoveAction

addRemoveAction(property: string): CommitBuilder
Parameters
- property: string
Returns CommitBuilder
- Defined in lib/src/commit.ts:120

addSetAction

addSetAction(property: string, value: JSONValue): CommitBuilder
Parameters
- property: string
- value: JSONValue
Returns CommitBuilder
- Defined in lib/src/commit.ts:101

clone

clone(): CommitBuilder
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
- Defined in lib/src/commit.ts:187

hasUnsavedChanges

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

Returns boolean
- Defined in lib/src/commit.ts:172

removeRemoveAction

removeRemoveAction(property: string): CommitBuilder
Parameters
- property: string
Returns CommitBuilder
- Defined in lib/src/commit.ts:129

setDestroy

setDestroy(destroy: boolean): CommitBuilder
Parameters
- destroy: boolean
Returns CommitBuilder
- Defined in lib/src/commit.ts:135

setPreviousCommit

setPreviousCommit(prev: string): CommitBuilder
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
- Defined in lib/src/commit.ts:145

setSubject

setSubject(subject: string): CommitBuilder
Parameters
- subject: string
Returns CommitBuilder
- Defined in lib/src/commit.ts:151

sign

sign(privateKey: string, agentSubject: string): Promise<Commit>
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>
- Defined in lib/src/commit.ts:161

signAt

signAt(agent: string, privateKey: string, createdAt: number): Promise<Commit>
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>
- Defined in lib/src/commit.ts:213

toPlainObject

toPlainObject(): CommitBuilderI
Returns CommitBuilderI
- Defined in lib/src/commit.ts:199

Generated using TypeDoc