Type alias PersistableActorInput<TLogic, TActor>

PersistableActorInput<TLogic, TActor>: {
    acquireLockMaxTimeout?: number;
    actorCreator: ((id, snapshot?) => TActor);
    id: string;
    locking?: "write" | "read-write";
    storageManager: ILockableStorageManager;
}

Defines the structure for the input parameters required by the withPersistance function. This interface is crucial for setting up a persistent actor in an XState context, providing necessary details like identification, storage management, and actor creation logic.

Type Parameters

  • TLogic extends AnyActorLogic

  • TActor extends Actor<TLogic>

Type declaration

  • Optional acquireLockMaxTimeout?: number

    The maximum timeout in milliseconds for acquiring a lock. This is an optional parameter that sets a limit on how long the system should wait to acquire a lock before timing out. It's used in conjunction with the locking mechanism.

  • actorCreator: ((id, snapshot?) => TActor)

    A factory function that creates an instance of the actor.

    Param: id

    The unique identifier of the actor.

    Param: snapshot

    An optional parameter that provides a previously persisted snapshot of the actor's state, allowing for state restoration.

    Example

    actorCreator: (id, snapshot) => {
      if (snapshot)
        throw new Error(
          `The subject=${id} already exists so it cannot be initiated`,
        );
      return createCloudOrchestrationActor(statemachine.logic, {
        version: statemachine.version,
        name: param.name,
        id,
        snapshot,
        input: initEvent.context,
        middleware: {
          onState: param.onOrchestrationState,
          onCloudEvent: param.onCloudEvent,
        },
      });
    }
    // Or
    actorCreator: (id, snapshot) => {
     // From xstate
     return createActor(createMachine({...}), {
       id,
       snapshot,
     })
    }
      • (id, snapshot?): TActor

      • A factory function that creates an instance of the actor.

        Parameters

        • id: string

          The unique identifier of the actor.

        • Optional snapshot: Snapshot<unknown>

          An optional parameter that provides a previously persisted snapshot of the actor's state, allowing for state restoration.

        Returns TActor

        Example

        actorCreator: (id, snapshot) => {
          if (snapshot)
            throw new Error(
              `The subject=${id} already exists so it cannot be initiated`,
            );
          return createCloudOrchestrationActor(statemachine.logic, {
            version: statemachine.version,
            name: param.name,
            id,
            snapshot,
            input: initEvent.context,
            middleware: {
              onState: param.onOrchestrationState,
              onCloudEvent: param.onCloudEvent,
            },
          });
        }
        // Or
        actorCreator: (id, snapshot) => {
         // From xstate
         return createActor(createMachine({...}), {
           id,
           snapshot,
         })
        }
  • id: string

    The unique identifier for the actor. This ID is used to differentiate between multiple instances and is crucial for tracking and managing the state of each actor.

  • Optional locking?: "write" | "read-write"

    Specifies the locking mode for the actor's persistence operations.

    • "write": Locks are only acquired during write operations.
    • "read-write": Locks are acquired during both read and write operations. This parameter is optional. If omitted, no locking mechanism is applied to the operations.
  • storageManager: ILockableStorageManager

    The storage manager responsible for persisting the state of the orchestration. Should implement the ILockableStorageManager interface for concurrent access control. This is governed by the npm package unified-serverless-storage see here.

    Note: The storageManager read method must return the snapshot, as JSON string, of the machine and the write function must be able to recieve and save the data passed to it as string. This string is the snapshot of the machine in JSON string format.

    Example

    // Example storage manager implementation.
    storageManager: myLockableStorageManager

Generated using TypeDoc