Variable OfflineContextConst

Type declaration

• [toStringTag]: string

• ReadOnly: Readonly<{
      [context]: Function;
      [toStringTag]: string;
      activity: NodeActivity.Activity | undefined;
      offline: true;
      trace?: Action;
      transaction: Transaction;
      agentFor<const T>(endpoint: Endpoint<T>): Instance<T>;
      authorizedFor(desiredAccessLevel: AccessLevel): desiredAccessLevel is View;
  }>

  Normally you need to use OfflineContext.act to work with behaviors, and you can only interact with the behaviors in the actor function. This ActionContext allows you to create offline agents that remain functional for the lifespan of the node.

  Write operations will throw an error with this context.

• act:function

  • act<T>(purpose, activity, actor, options?): MaybePromise<T>

  • Operate in offline context. Interactions with private Matter.js APIs happen in an offline context.

    act provides an ActionContext you can use to access agents for a Endpoint. State changes and change events occur once actor returns.

    The Transaction is destroyed with act exits so you should not keep a reference to any agents beyond the lifespan of actor.

    Offline context is very permissive. You should use carefully.

    Type Parameters

    • T

    Parameters

    • purpose: string
    • activity: undefined | NodeActivity
    • actor: ((context: ActionContext) => MaybePromise<T>)
      • • (context): MaybePromise<T>

        • Parameters

          • context: ActionContext

          Returns MaybePromise<T>

    • Optionaloptions: OfflineContext.Options

    Returns MaybePromise<T>