prorm API Reference
    Preparing search index...

    Interface ExternalStoreAdapter

    The uniform surface external fields are written against.

    container is a bucket (S3/R2/MinIO/GCS) or container (Azure). Stores with no container concept - Redis - ignore it.

    interface ExternalStoreAdapter {
        engine: string;
        usesContainer: boolean;
        put(
            container: string | undefined,
            key: string,
            value: ExternalValue,
            options?: ExternalPutOptions,
        ): Promise<void>;
        get(
            container: string | undefined,
            key: string,
        ): Promise<Buffer<ArrayBufferLike> | null>;
        delete(container: string | undefined, key: string): Promise<void>;
        exists(container: string | undefined, key: string): Promise<boolean>;
    }
    Index
    engine usesContainer
    put get delete exists
    engine: string

    Identifies the underlying engine, for error messages.

    usesContainer: boolean

    Whether this engine has a bucket/container concept.

    • Parameters

      • container: string | undefined
      • key: string

      Returns Promise<Buffer<ArrayBufferLike> | null>

    • Parameters

      • container: string | undefined
      • key: string

      Returns Promise<void>

    • Parameters

      • container: string | undefined
      • key: string

      Returns Promise<boolean>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods