basalt / storage-azure/src / AzureBlobLike
Interface: AzureBlobLike
Defined in: storage-azure/src/index.ts:31
The subset of an @azure/storage-blob BlockBlobClient this driver uses.
Properties
url?
> readonly optional url?: string
Defined in: storage-azure/src/index.ts:49
Methods
deleteIfExists()
> deleteIfExists(): Promise<{ succeeded: boolean; }>
Defined in: storage-azure/src/index.ts:35
Returns
Promise<{ succeeded: boolean; }>
download()?
> optional download(offset?): Promise<{ readableStreamBody?: ReadableStream; }>
Defined in: storage-azure/src/index.ts:45
Streaming download; readableStreamBody is undefined only in the browser bundle.
Parameters
offset?
number
Returns
Promise<{ readableStreamBody?: ReadableStream; }>
downloadToBuffer()
> downloadToBuffer(): Promise<Buffer<ArrayBufferLike>>
Defined in: storage-azure/src/index.ts:33
Returns
Promise<Buffer<ArrayBufferLike>>
exists()
> exists(): Promise<boolean>
Defined in: storage-azure/src/index.ts:34
Returns
Promise<boolean>
generateSasUrl()
> generateSasUrl(options): Promise<string>
Defined in: storage-azure/src/index.ts:36
Parameters
options
contentDisposition?
string
expiresOn
Date
permissions
string
Returns
Promise<string>
getProperties()?
> optional getProperties(): Promise<AzureBlobProperties>
Defined in: storage-azure/src/index.ts:48
Returns
Promise<AzureBlobProperties>
syncCopyFromURL()?
> optional syncCopyFromURL(source, options?): Promise<unknown>
Defined in: storage-azure/src/index.ts:47
Server-side copy from a (SAS) URL, completed before it resolves.
Parameters
source
string
options?
blobHTTPHeaders?
{ blobContentType?: string; }
blobHTTPHeaders.blobContentType?
string
Returns
Promise<unknown>
uploadData()
> uploadData(data, options?): Promise<unknown>
Defined in: storage-azure/src/index.ts:32
Parameters
data
Buffer
options?
blobHTTPHeaders?
{ blobContentType?: string; }
blobHTTPHeaders.blobContentType?
string
Returns
Promise<unknown>
uploadStream()?
> optional uploadStream(stream, bufferSize?, maxConcurrency?, options?): Promise<unknown>
Defined in: storage-azure/src/index.ts:38
Block-blob streaming upload — the SDK chunks the readable for us.
Parameters
stream
Readable
bufferSize?
number
maxConcurrency?
number
options?
blobHTTPHeaders?
{ blobContentType?: string; }
blobHTTPHeaders.blobContentType?
string
Returns
Promise<unknown>