prorm API Reference
    Preparing search index...

    Interface S3StoreOptions

    Connection options for S3Store.

    interface S3StoreOptions {
        region?: string;
        credentials?: {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        };
        endpoint?: string;
        forcePathStyle?: boolean;
        client?: S3ClientLike;
    }
    Index
    region? credentials? endpoint? forcePathStyle? client?
    region?: string

    AWS region, e.g. 'us-east-1'.

    credentials?: {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Static credentials. Omit to fall back to the default AWS credential provider chain.

    endpoint?: string

    Override the service endpoint, e.g. 'http://localhost:9000' for a MinIO / LocalStack S3-compatible server. When set, region and credentials can be dummy values for servers that don't validate them.

    forcePathStyle?: boolean

    Use path-style bucket addressing (endpoint/bucket/key) instead of virtual-hosted-style (bucket.endpoint/key). Usually required for MinIO / LocalStack and other S3-compatible servers.

    client?: S3ClientLike

    A pre-built S3Client (or compatible object). When provided, connect() uses it directly and does NOT require the SDK — this is how tests inject a mock client, and how callers can supply a custom-configured client. When omitted, connect() builds a real S3Client from the options above.

    Settings
    Member Visibility

    On This Page
    Properties