prorm API Reference
    Preparing search index...

    Interface AzureBlobStoreOptions

    Connection options for AzureBlobStore.

    Provide exactly one of:

    • client: a pre-built BlobServiceClient (used as-is; the SDK is not require()d — this is how tests inject a mock).
    • connectionString: an Azure Storage connection string, used to build a client via BlobServiceClient.fromConnectionString(...).
    • account + accountKey: builds a connection string from an account name and key (convenience over connectionString).
    interface AzureBlobStoreOptions {
        client?: BlobServiceClientLike;
        connectionString?: string;
        account?: string;
        accountKey?: string;
        endpointSuffix?: string;
    }
    Index
    client? connectionString? account? accountKey? endpointSuffix?
    client?: BlobServiceClientLike

    A pre-built BlobServiceClient. When given, connect() uses it directly and never loads the SDK.

    connectionString?: string

    Azure Storage connection string, e.g. DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...;.

    account?: string

    Storage account name (used with accountKey to synthesize a connection string).

    accountKey?: string

    Storage account key (used with account).

    endpointSuffix?: string

    Endpoint suffix for the synthesized connection string. Defaults to core.windows.net.

    Settings
    Member Visibility

    On This Page
    Properties