Class BlobsStorage

A class that implements the Storage interface using Azure Blob Storage. Provides persistence for bot state data using Azure's Blob Storage service.

Implements

Storage

Index

Constructors

Methods

delete read write

Constructors

constructor

new BlobsStorage(
    containerName: string,
    connectionString?: string,
    options?: BlobsStorageOptions,
    url?: string,
    credential?:
        | StorageSharedKeyCredential
        | AnonymousCredential
        | TokenCredential,
): BlobsStorage
Creates a new instance of the BlobsStorage class.
Parameters
- containerName: string
  The name of the Blob container to use
- OptionalconnectionString: string
  Optional, The Azure Storage connection string
- Optionaloptions: BlobsStorageOptions
  Optional configuration settings for the storage provider
- url: string = ''
  Optional URL to the blob service (used instead of connectionString if provided)
- Optionalcredential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
  Optional credential for authentication (used with url if provided)
Returns BlobsStorage
- Defined in blobsStorage.ts:47

Methods

delete

delete(keys: string[]): Promise<void>
Deletes storage items from blob storage.
Parameters
- keys: string[]
  Array of item keys to delete
Returns Promise<void>
A promise that resolves when the delete operation is complete

Throws
Will throw if keys parameter is invalid
Implementation of Storage.delete
- Defined in blobsStorage.ts:172

read

read(keys: string[]): Promise<StoreItems>
Reads storage items from blob storage.
Parameters
- keys: string[]
  Array of item keys to read
Returns Promise<StoreItems>
A promise that resolves to a StoreItems object containing the retrieved items

Throws
Will throw if keys parameter is invalid or if there's an error reading from storage
Implementation of Storage.read
- Defined in blobsStorage.ts:101

write

write(changes: StoreItems): Promise<void>
Writes storage items to blob storage.
Parameters
- changes: StoreItems
  The items to write to storage
Returns Promise<void>
A promise that resolves when the write operation is complete

Throws
Will throw if there's a validation error, eTag conflict, or other storage error
Implementation of Storage.write
- Defined in blobsStorage.ts:139