Options
All
  • Public
  • Public/Protected
  • All
Menu
see

m-ld specification

Hierarchy

Index

Properties

Optional Readonly @agree

@agree: any

If this key is included and the value is truthy, this update is an agreement. The value may include serialisable proof that applicable agreement conditions have been met, such as a key to a ledger entry.

experimental

Readonly @delete

@delete: GraphSubjects

Partial subjects, containing properties that have been deleted from the domain. Note that deletion of a property (even of all properties) does not necessarily indicate that the subject's identity is not longer represented in the domain.

Readonly @insert

@insert: GraphSubjects

Partial subjects, containing properties that have been inserted into the domain.

Optional Readonly @principal

@principal: Reference

An identified security principal (user or machine) that is responsible for this update.

experimental

Readonly @ticks

@ticks: number

Current local clock ticks at the time of the update.

see

MeldStatus.ticks

Readonly @update

@update: GraphSubjects

Partial subjects, containing only properties with a SharedDatatype in the domain, which have been operated on. Subject property values under this key will typically be inline constraint expressions using mutation operators like @plus, which must be interpreted by the receiving code.

Note that most data changes appear as combinations of @delete and @insert, even if the original user update used the @update keyword, because most data in the domain comprises atomic immutable values which are updated by replacement. Shared data types, in contrast, are mutable and their updates can only be provided using expressions.

Methods

trace

  • Traces through to the underlying m-ld protocol information that gave rise to this update.

    Returns UpdateTrace

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method
  • Protected method

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.0 Source code licensed MIT. Privacy policy