Interface IStorageSchema<T>

Interface representing the schema for storage configuration. Defines how storage behaves, including persistence, indexing, and data access.

interface IStorageSchema<T extends IStorageData = IStorageData> {
    callbacks?: Partial<IStorageCallbacks<T>>;
    docDescription?: string;
    embedding: string;
    getData?: (
        clientId: string,
        storageName: string,
        defaultValue: T[],
    ) => T[] | Promise<T[]>;
    getDefaultData?: (
        clientId: string,
        storageName: string,
    ) => T[] | Promise<T[]>;
    persist?: boolean;
    setData?: (
        data: T[],
        clientId: string,
        storageName: string,
    ) => void | Promise<void>;
    shared?: boolean;
    storageName: string;
    createIndex(item: T): string | Promise<string>;
}

Type Parameters

Properties

callbacks? docDescription? embedding getData? getDefaultData? persist? setData? shared? storageName

Methods

createIndex

Properties

Optionalcallbacks

callbacks?: Partial<IStorageCallbacks<T>>

Optional partial set of lifecycle callbacks for storage events, allowing customization.

OptionaldocDescription

docDescription?: string

Optional description for documentation purposes, aiding in storage usage understanding.

embedding

embedding: string

The name of the embedding mechanism used for indexing and searching storage data.

OptionalgetData

getData?: (
    clientId: string,
    storageName: string,
    defaultValue: T[],
) => T[] | Promise<T[]>

Optional function to retrieve data from the storage, overriding default behavior.

Type declaration

    • (clientId: string, storageName: string, defaultValue: T[]): T[] | Promise<T[]>

    • Parameters

      • clientId: string

        The unique ID of the client requesting the data.

      • storageName: string

        The unique name of the storage.

      • defaultValue: T[]

        The default data to return if no data is found.

      Returns T[] | Promise<T[]>

      The stored data, synchronously or asynchronously.

OptionalgetDefaultData

getDefaultData?: (clientId: string, storageName: string) => T[] | Promise<T[]>

Optional function to provide the default data for the storage, resolved in persistence logic.

Type declaration

    • (clientId: string, storageName: string): T[] | Promise<T[]>

    • Parameters

      • clientId: string

        The unique ID of the client requesting the default data.

      • storageName: string

        The unique name of the storage.

      Returns T[] | Promise<T[]>

      The default data array, synchronously or asynchronously.

Optionalpersist

persist?: boolean

Optional flag to enable serialization of storage data to persistent storage (e.g., hard drive).

OptionalsetData

setData?: (
    data: T[],
    clientId: string,
    storageName: string,
) => void | Promise<void>

Optional function to persist storage data to the hard drive, overriding default behavior.

Type declaration

    • (data: T[], clientId: string, storageName: string): void | Promise<void>

    • Parameters

      • data: T[]

        The data to persist.

      • clientId: string

        The unique ID of the client updating the storage.

      • storageName: string

        The unique name of the storage.

      Returns void | Promise<void>

      A promise that resolves when data is persisted, or void if synchronous.

Throws

If persistence fails (e.g., due to disk errors).

Optionalshared

shared?: boolean

Optional flag indicating whether the storage instance is shared across all agents for a client.

storageName

storageName: string

The unique name of the storage within the swarm.

Methods

createIndex

  • createIndex(item: T): string | Promise<string>

    Function to generate an index for a storage item, used for search and retrieval.

    Parameters

    • item: T

      The storage item to index.

    Returns string | Promise<string>

    The index string for the item, synchronously or asynchronously.

Settings

Member Visibility

On This Page

Properties
Methods