Options
All
  • Public
  • Public/Protected
  • All
Menu

Read methods for a MeldState.

Methods are typed to ensure that app code is aware of m-ld data semantics. See the Resource type for more details.

Hierarchy

Index

Methods

Methods

get

  • get<S>(id: string): Promise<Resource<S> | undefined>
  • Shorthand method for retrieving a single Subject by its @id, if it exists.

    Type parameters

    • S

    Parameters

    • id: string

      the Subject @id

    Returns Promise<Resource<S> | undefined>

    a promise resolving to the requested Subject, or undefined if not found

read

  • 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.

    see

    MeldStateMachine.read

    Type parameters

    Parameters

    • request: R

      the declarative read description

    Returns ReadResult<Resource<S>>

    read subjects

Legend

  • Property
  • Method

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