Class PersistMemoryInstance

Default file-based implementation of IPersistMemoryInstance.

Features:

  • Wraps PersistBase for atomic JSON writes
  • Soft delete via removed: true flag
  • listMemoryData filters out removed entries
  • dispose is a no-op (memo cache is managed by PersistMemoryUtils)

Example

const instance = new PersistMemoryInstance("signal-1", "context-bucket");
await instance.waitForInit(true);
await instance.writeMemoryData(entryData, "memory-id-1");
const data = await instance.readMemoryData("memory-id-1");

Implements

Constructors

constructor

Properties

bucketName signalId

Methods

dispose hasMemoryData listMemoryData readMemoryData removeMemoryData waitForInit writeMemoryData

Constructors

constructor

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

    Creates new memory persistence instance.

    Parameters

    • signalId: string

      Signal identifier (entity folder name)

    • bucketName: string

      Bucket name (subfolder under memory/)

    Returns PersistMemoryInstance

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 PersistMemoryUtils.dispose().

    Returns void

hasMemoryData

  • hasMemoryData(memoryId: string): Promise<boolean>

    Checks whether a memory entry exists on disk (regardless of removed flag).

    Parameters

    • memoryId: string

      Memory entry identifier

    Returns Promise<boolean>

    Promise resolving to true if entry file exists

listMemoryData

  • listMemoryData(): AsyncGenerator<{ data: MemoryData; memoryId: string }>

    Iterates all memory entries in the bucket, yielding id + data tuples for non-removed entries only.

    Returns AsyncGenerator<{ data: MemoryData; memoryId: string }>

    AsyncGenerator yielding { memoryId, data } tuples

readMemoryData

removeMemoryData

  • removeMemoryData(memoryId: string): Promise<void>

    Soft-deletes a memory entry by writing removed: true flag.

    Parameters

    • memoryId: string

      Memory entry identifier

    Returns Promise<void>

    Promise that resolves when removal is complete

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

writeMemoryData

  • writeMemoryData(data: MemoryData, memoryId: string, _when: Date): Promise<void>

    Writes a memory entry under the given id.

    Parameters

    • data: MemoryData

      Entry data to persist

    • memoryId: string

      Memory entry identifier

    • _when: Date

    Returns Promise<void>

    Promise that resolves when write is complete

Settings

Member Visibility

On This Page

Constructors
Properties
Methods