Interface Commit

A Commit represents a (set of) changes to one specific Resource. See https://atomicdata.dev/classes/Commit If you want to create a Commit, you should probably use the CommitBuilder and call .sign() on it.

Hierarchy

Properties

createdAt destroy? id? previousCommit? push? remove? set? signature signer subject

Properties

createdAt

createdAt: number

Unix timestamp in milliseconds, see https://atomicdata.dev/properties/createdAt

Optional destroy

destroy?: boolean

If true, the resource must be deleted. https://atomicdata.dev/properties/destroy

Optional id

id?: string

Subject of created Commit. Will only be present after it was accepted and applied by the Server.

Optional previousCommit

previousCommit?: string

URL of the previous Commit, used by the receiver to make sure that we're having the same current version.

Optional push

push?: Record<string, JSONArray>

The property-value combinations for which one or more ResourceArrays will be appended. https://atomicdata.dev/properties/push

Optional remove

remove?: string[]

The properties that need to be removed. https://atomicdata.dev/properties/remove

Optional set

set?: Record<string, JSONValue>

The property-value combinations being edited https://atomicdata.dev/properties/set

signature

signature: string

https://atomicdata.dev/properties/signature

signer

signer: string

https://atomicdata.dev/properties/signer

subject

subject: string

The resource being edited

Settings

Member Visibility

Theme

Generated using TypeDoc