Class AzureBlobStore

constructor

• new AzureBlobStore(options?: AzureBlobStoreOptions): AzureBlobStore

  Parameters

  • options: AzureBlobStoreOptions = {}

  Returns AzureBlobStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): BlobServiceClientLike

  Returns the underlying BlobServiceClient for anything not wrapped here.

  Returns BlobServiceClientLike

uploadBlob

• uploadBlob(container: string, key: string, data: BlobUploadData): Promise<void>

  Uploads data to container/key, creating or overwriting the block blob.

  Parameters

  • container: string
  • key: string
  • data: BlobUploadData

  Returns Promise<void>

downloadBlob

• downloadBlob(container: string, key: string): Promise<Buffer<ArrayBufferLike>>

  Downloads container/key and returns its full contents as a Buffer.

  Parameters

  • container: string
  • key: string

  Returns Promise<Buffer<ArrayBufferLike>>

deleteBlob

• deleteBlob(container: string, key: string): Promise<void>

  Deletes container/key.

  Parameters

  • container: string
  • key: string

  Returns Promise<void>

blobExists

• blobExists(container: string, key: string): Promise<boolean>

  Returns whether container/key exists.

  Parameters

  • container: string
  • key: string

  Returns Promise<boolean>

listBlobs

• listBlobs(container: string, prefix?: string): Promise<string[]>

  Lists the names of all blobs in container, optionally filtered to those whose name starts with prefix. Iterates the SDK's async paging iterator (listBlobsFlat) fully and returns a flat array of blob names.

  Parameters

  • container: string
  • Optionalprefix: string

  Returns Promise<string[]>

createContainer

• createContainer(container: string): Promise<void>

  Creates container.

  Parameters

  • container: string

  Returns Promise<void>