Class PersistStateInstance

Default file-based implementation of IPersistStateInstance.

Features:

  • Wraps PersistBase for atomic JSON writes
  • Uses bucketName as entity ID within a per-signal PersistBase
  • dispose is a no-op (memo cache is managed by PersistStateUtils)

Example

const instance = new PersistStateInstance("signal-1", "counter");
await instance.waitForInit(true);
await instance.writeStateData({ id: "counter", data: { count: 1 } });
const state = await instance.readStateData();

Implements

Constructors

constructor

Properties

bucketName signalId

Methods

dispose readStateData waitForInit writeStateData

Constructors

constructor

  • new PersistStateInstance(
        signalId: string,
        bucketName: string,
    ): PersistStateInstance

    Creates new state persistence instance.

    Parameters

    • signalId: string

      Signal identifier (folder name under state/)

    • bucketName: string

      Bucket name (file name)

    Returns PersistStateInstance

Properties

ReadonlybucketName

bucketName: string

ReadonlysignalId

signalId: string

Methods

dispose

  • dispose(): void

    No-op for the default file-based implementation. Resource cleanup (memo cache invalidation) is handled by PersistStateUtils.dispose().

    Returns void

readStateData

waitForInit

  • waitForInit(initial: boolean): Promise<void>

    Initializes the underlying PersistBase storage.

    Parameters

    • initial: boolean

      Whether this is the first initialization

    Returns Promise<void>

    Promise that resolves when initialization is complete

writeStateData

Settings

Member Visibility

On This Page

Constructors
Properties
Methods