Shorthand method to test whether or not a query pattern has a solution. No information is returned about the possible query solutions, just whether or not a solution exists.
a query with a @where
pattern to test
resolves to true
if the query's @where
pattern matches data in the domain
Shorthand method for deleting a single Subject by its @id
. This will also
remove references to the given Subject from other Subjects.
the Subject @id
Shorthand method for retrieving a single Subject and its properties by
its @id
, if it exists.
the Subject @id
the properties to retrieve. If no properties are specified, all available properties of the subject will be returned.
a promise resolving to the requested Subject with the requested
properties, or undefined
if not found
Returns a stream that processes all quads matching the pattern.
The optional subject.
The optional predicate.
The optional object.
The optional graph.
The resulting quad stream.
Actively reads data from the domain.
The query executes in response to either subscription to the returned
result, or calling .then
.
All results are guaranteed to derive from the current state; however since the observable results are delivered asynchronously, the current state is not guaranteed to be live in the subscriber. In order to keep this state alive during iteration (for example, to perform a consequential operation), perform the read in the scope of a read procedure.
the declarative read description
read subjects
Performs an atomic update to the dataset. The deletes and inserts will be committed in the resolved state, which is expected to also be updatable for further modifications.
Actively writes data to the domain.
As soon as this method is called, this current state is no longer 'live' (write will throw). To keep operating on state, use the returned new state.
the declarative write description
the next state of the domain, changed by this write operation only
Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.1-edge.4 Source code licensed MIT. Privacy policy
A data state corresponding to a local clock tick. A state can be some initial state (an new clone), or follow a write operation, which may have been transacted locally in this clone, or remotely on another clone.
The
get
anddelete
methods are intentionally suggestive of a REST API, which could be implemented by the class when used in a service environment.If a data state is not available ('live') for read and write operations, the methods will throw. Liveness depends on how this state was obtained. A mutable state such as a MeldClone is always live until it is closed. An immutable state such as obtained in a read or write procedure is live until either a write is performed in the procedure, or the procedure's asynchronous return promise resolves or rejects.
MeldStateMachine.read
MeldStateMachine.write
m-ld specification