@backblaze-labs/b2-sdk - v0.1.0
    Preparing search index...

    Module index

    Backblaze B2 Cloud Storage SDK for TypeScript/JavaScript.

    The root module re-exports the high-level facade (B2Client, Bucket, B2Object), error types, auth backends, streaming utilities, HTTP transport, and all request/response type definitions. Most applications only need this import.

    Classes

    B2Client
    B2Object
    BlobSource
    Bucket
    BufferSource
    EncryptionKey
    FetchTransport
    IncrementalSha1
    InMemoryAccountInfo
    RetryTransport
    StreamSource
    UrlGuard

    Interfaces

    AccountInfo
    AllowedInfo
    ApiInfo
    ApplicationKey
    AuthorizeAccountRequest
    AuthorizeAccountResponse
    B2ClientOptions
    B2ErrorResponse
    BrandTag
    BucketInfo
    BucketRetentionPolicy
    CancelLargeFileRequest
    CancelLargeFileResponse
    CapabilityCheckResult
    ContentSource
    CopyFileRequest
    CopyPartRequest
    CopyPartResponse
    CorsRule
    CreateBucketRequest
    CreateKeyRequest
    DeleteAllDeleteEvent
    DeleteAllErrorEvent
    DeleteAllSkipEvent
    DeleteBucketRequest
    DeleteError
    DeleteFileVersionRequest
    DeleteFileVersionResponse
    DeleteKeyRequest
    DeleteManyResult
    DeleteTarget
    DownloadAuthorizationRequest
    DownloadAuthorizationResponse
    DownloadByIdRequest
    DownloadByNameRequest
    DownloadCallOptions
    DownloadHeaders
    DownloadResult
    EventNotificationRule
    FileRetentionValue
    FileVersion
    FinishLargeFileRequest
    FullApplicationKey
    GetBucketNotificationRulesRequest
    GetBucketNotificationRulesResponse
    GetFileInfoRequest
    GetUploadPartUrlRequest
    GetUploadPartUrlResponse
    GetUploadUrlRequest
    GetUploadUrlResponse
    GroupsApiInfo
    HeadResult
    HideFileRequest
    HttpRequest
    HttpResponse
    HttpTransport
    LifecycleRule
    ListBucketsRequest
    ListBucketsResponse
    ListFileNamesRequest
    ListFileNamesResponse
    ListFileVersionsRequest
    ListFileVersionsResponse
    ListKeysRequest
    ListKeysResponse
    ListPartsRequest
    ListPartsResponse
    ListUnfinishedLargeFilesRequest
    ListUnfinishedLargeFilesResponse
    NoEncryption
    PaginatorOptions
    PartInfo
    ProgressEvent
    ReplicationConfiguration
    ReplicationDestination
    ReplicationRule
    ReplicationSource
    RetentionPeriod
    RetryOptions
    RetryTransportOptions
    SetBucketNotificationRulesRequest
    SseB2Setting
    SseCCustomerSetting
    StartLargeFileRequest
    StartLargeFileResponse
    StorageApiInfo
    UnfinishedLargeFile
    UpdateBucketRequest
    UpdateFileLegalHoldRequest
    UpdateFileLegalHoldResponse
    UpdateFileRetentionRequest
    UpdateFileRetentionResponse
    UploadFileHeaders
    UploadPartHeaders
    UploadPartResponse
    UploadUrlEntry
    UploadWriteHandle

    Type Aliases

    AccountId
    ApplicationKeyId
    AuthToken
    B2ErrorCode
    Brand
    BucketId
    BucketRetentionMode
    BucketType
    Capability
    CorsOperation
    DeleteAllEvent
    EncryptionAlgorithm
    EncryptionMode
    EncryptionSetting
    EventType
    FileAction
    FileId
    HeadCallOptions
    KeyId
    LargeFileId
    LegalHoldValue
    MetadataDirective
    PageFetcher
    ProgressListener
    RetentionMode
    SetBucketNotificationRulesResponse
    UploadAuthToken
    UploadUrl

    Variables

    BucketRetentionMode
    BucketType
    Capability
    CorsOperation
    EncryptionAlgorithm
    EncryptionMode
    EventType
    FileAction
    LegalHoldValue
    MetadataDirective
    RetentionMode
    SSE_B2
    SSE_NONE
    VERSION

    Functions

    accountId
    applicationKeyId
    bucketId
    deriveAllowedSuffixes
    fileId
    keyId
    largeFileId
    paginateItems
    paginatePages
    sha1Hex
    sseCustomer
    toContentSource

    References

    AccessDeniedError → AccessDeniedError
    B2Error → B2Error
    B2InsufficientCapabilityError → B2InsufficientCapabilityError
    B2SsrfError → B2SsrfError
    BadAuthTokenError → BadAuthTokenError
    BadRequestError → BadRequestError
    BadUploadUrlError → BadUploadUrlError
    CapExceededError → CapExceededError
    ChecksumMismatchError → ChecksumMismatchError
    classifyError → classifyError
    DownloadFileOptions → DownloadFileOptions
    DuplicateBucketNameError → DuplicateBucketNameError
    ExpiredAuthTokenError → ExpiredAuthTokenError
    FileNotPresentError → FileNotPresentError
    NetworkError → NetworkError
    RawClient → RawClient
    RawClientOptions → RawClientOptions
    RequestTimeoutError → RequestTimeoutError
    ServiceUnavailableError → ServiceUnavailableError
    SseCDownloadKey → SseCDownloadKey
    TooManyRequestsError → TooManyRequestsError