@m-ld/m-ld - v0.8.2
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Properties

Methods

Properties

Readonly agreementConditions

agreementConditions: AgreementCondition[] = [{test: (state, update) => this.withActiveState(state, () =>Promise.all(this.statutes.map(statute => statute.test(state, update))))}]

Readonly constraints

constraints: MeldConstraint[] = [{check: (state, update) => this.withActiveState(state, () =>Promise.all(this.statutes.map(statute => statute.check(state, update))))}]

Methods

initialise

onUpdate

withActiveState

Static declare

  • declare(priority: number): Subject

  • Extension declaration. Insert into the domain data to install the extension. For example (assuming a m-ld clone object):

    clone.write(Statutory.declare(0));

    Parameters

    • priority: number

      the preferred index into the existing list of extensions (lower value is higher priority).

    Returns Subject

Static declareAuthority

  • Declares a principal to have authority over some shape, for example (assuming a m-ld clone object):

    clone.write(Statutory.declareAuthority(
  'https://alice.example/profile#me',
  { '@id': 'documentStateShape' }
));

    Parameters

    • principalIri: Iri

      the principal's identity. As for all domain data, this can be a relative IRI, e.g. 'fred'.

    • shape: Subject | Reference

      the shape Subject, or a Reference to a pre-existing shape

    Returns Subject

Static declareStatute

  • Declares that some set of shapes are statutory, that is, they cannot change without agreement. In order to have agreement, the given conditions must be met.

    For example (assuming a m-ld clone object):

    clone.write(Statutory.declareStatute(
  'https://alice.example/profile#me',
  { '@id': 'documentStateShape' }
));

    Parameters

    Returns Subject

Legend

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

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