Interface BuildClientOptions

interface BuildClientOptions {
    applicationKey: string;
    applicationKeyId: string;
    bucket: string;
    endpoint?: string;
    transport?: HttpTransport;
}

Properties

applicationKey: string

B2 application key (the secret). Masked via core.setSecret by the dispatcher.

applicationKeyId: string

B2 application key ID. Masked via core.setSecret by the dispatcher (defense in depth).

bucket: string

Target bucket name (stored on the result for later getBucket resolution).

endpoint?: string

Override the default B2 realm endpoint. Only set for staging / custom realms.

transport?: HttpTransport

Inject a custom transport (used by tests with the SDK's B2Simulator).