MeldExtensions | @m-ld/m-ld

Extensions applied to a m-ld clone.

In general, extensions should be dynamically selected and loaded based on the clone's (meta)data content – this allows a domain to evolve without necessitating the redeployment of app code.

⚠ Changing extensions at runtime may require coordination between clones, to prevent outdated clones from acting incorrectly in ways that could cause data corruption or compromise security. Consult the extension's documentation for safe operation.

experimental

Hierarchy

MeldExtensions

Implemented by

Index

Properties

Optional Readonly agreementConditions

agreementConditions: Iterable<AgreementCondition>

Agreement preconditions applicable to the domain.

experimental

Optional Readonly constraints

constraints: Iterable<MeldConstraint>

Data invariant constraints applicable to the domain.

experimental
see: https://github.com/m-ld/m-ld-spec/issues/73

Optional Readonly initialise

initialise: StateProc

Initialises the extensions against the given clone state. This method could be used to read significant state into memory for the efficient implementation of an extension's function.

Optional Readonly onUpdate

onUpdate: UpdateProc<MeldPreUpdate>

Called to inform the extensions of an update to the state, after it has been applied. If available, this procedure will be called for every state after that passed to initialise.

Optional Readonly transportSecurity

transportSecurity: MeldTransportSecurity

A transport security interceptor. If the initial transport security is not compatible with the rest of the domain, this clone may not be able to join until the app is updated.

experimental

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