Beignet API reference
    Preparing search index...

    Interface VercelBlobStorageOptions

    Options for creating a Vercel Blob storage port directly.

    interface VercelBlobStorageOptions {
        access?: StorageVisibility;
        client?: VercelBlobClient;
        instrumentation?: ProviderInstrumentationTarget;
        keyPrefix?: string;
        storeId?: string;
        token?: string;
    }
    Index
    access? client? instrumentation? keyPrefix? storeId? token?
    access?: StorageVisibility

    Store-wide access level applied to every object.

    Vercel Blob stores per-object access at write time but does not report it back from head(...), so this adapter keeps the whole store uniform: writes that request a different visibility are rejected with an error instead of silently misreporting visibility on later reads. Run two providers over two stores when an app needs both levels.

    "private"
    client?: VercelBlobClient

    Vercel Blob SDK surface. Omit to use @vercel/blob directly; inject a fake in tests.

    instrumentation?: ProviderInstrumentationTarget

    Optional instrumentation target. The provider passes existing app ports automatically; direct factory users can pass an instrumentation port.

    keyPrefix?: string

    Prefix all object keys before sending them to the store.

    storeId?: string

    Blob store id used with Vercel OIDC authentication. Passed explicitly to every SDK operation instead of relying on process-global env state.

    token?: string

    Read-write token. Omit to let @vercel/blob read BLOB_READ_WRITE_TOKEN from the environment.

    Settings
    Member Visibility

    On This Page
    Properties