@azure/storage-common package

AnonymousCredential provides a credentialPolicyCreator member used to create AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources or for use with Shared Access Signatures (SAS).

The base class from which all request policies derive.

This class accepts a Node.js Readable stream as input, and keeps reading data from the stream into the internal buffer structure, until it reaches maxBuffers. Every available buffer will try to trigger outgoingHandler.

The internal buffer structure includes an incoming buffer array, and a outgoing buffer array. The incoming buffer array includes the "empty" buffers can be filled with new incoming data. The outgoing array includes the filled buffers to be handled by outgoingHandler. Every above buffer size is defined by parameter bufferSize.

NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING

NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers

PERFORMANCE IMPROVEMENT TIPS:

1. Input stream highWaterMark is better to set a same value with bufferSize parameter, which will avoid Buffer.concat() operations.
2. concurrency should set a smaller value than maxBuffers, which is helpful to reduce the possibility when a outgoing handler waits for the stream data. in this situation, outgoing handlers are blocked. Outgoing queue shouldn't be empty.

Credential is an abstract class for Azure Storage HTTP requests signing. This class will host an credentialPolicyCreator factory which generates CredentialPolicy.

Credential policy used to sign HTTP(S) requests before sending. This is an abstract class.

StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:

1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'. StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL thus avoid the browser cache.

2. Remove cookie header for security

3. Remove content-length header to avoid browsers warning

In Node.js, this policy is a no-op pass-through.

StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.

Class used to calculator CRC64 checksum

Retry policy with exponential retry and linear retry implemented.

StorageRetryPolicyFactory is a factory class helping generating StorageRetryPolicy objects.

ONLY AVAILABLE IN NODE.JS RUNTIME.

StorageSharedKeyCredential for account key authorization of Azure Storage service.

StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.

ONLY AVAILABLE IN NODE.JS RUNTIME.

UserDelegationKeyCredential is only used for generation of user delegation SAS.

See https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

A Node.js Readable stream that also has a destroy method.

Storage Blob retry options interface.

Options used to configure StorageSharedKeyCredentialPolicy.

Options used when creating StructuredMessageDecodingStream

Options used when creating StructuredMessageEncodingStream

A user delegation key.

A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.

OutgoingHandler is an async function triggered by BufferScheduler.

RetryPolicy types.

A factory method used to generated a RetryPolicy factory.

Allocates a new zero-filled Buffer of the given size.

Creates a Buffer from an ArrayBuffer, with optional offset and length.

Creates a Blob from the given data. Uses an indirect constructor reference to work around React Native's restrictive Blob type definitions (which only accept string | Blob, not ArrayBuffer).

Returns the byte length of a buffer.

Checks whether a value is a Node.js Buffer.

storageBrowserPolicy is a policy used to prevent browsers from caching requests and to remove cookies and explicit content-length headers.

In Node.js, this policy is a no-op pass-through.

storageCorrectContentLengthPolicy to correctly set Content-Length header with request body length.

StorageRequestFailureDetailsParserPolicy

Retry policy with exponential retry and linear retry implemented.

storageSharedKeyCredentialPolicy handles signing requests using storage account keys.

To decode structured body for CRC64 content validtion in storage downloading.

To decode structured body for CRC64 content validtion in storage downloading.

To encode structured body for CRC64 content validtion in storage uploading.

The programmatic identifier of the StorageBrowserPolicy.

The programmatic identifier of the storageCorrectContentLengthPolicy.

The programmatic identifier of the StorageRequestFailureDetailsParserPolicy.

Name of the storageRetryPolicy

The programmatic identifier of the storageSharedKeyCredentialPolicy.