@azure/storage-common package

Классы

AnonymousCredential	AnonymousCredential предоставляет элемент credentialPolicyCreator, используемый для создания объектов AnonymousCredentialPolicy. AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
AnonymousCredentialPolicy	AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
BaseRequestPolicy	Базовый класс, из которого наследуют все политики запросов.
BufferScheduler	Этот класс принимает поток Node.js для чтения в качестве входных данных и сохраняет чтение данных из потока во внутреннюю структуру буфера, пока не достигнет maxBuffers. Каждый доступный буфер попытается активировать исходящийHandler. Внутренняя структура буфера включает входящий массив буфера и исходящий массив буферов. Входящий массив буферов включает в себя "пустые" буферы, которые можно заполнить новыми входящими данными. Исходящий массив включает заполненные буферы, которые обрабатываются исходящимHandler. Каждый указанный выше размер буфера определяется параметром bufferSize. NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING NUM_OF_ALL_BUFFERS меньше или равно maxBuffers СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ: Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat(). concurrency должен устанавливать меньшее значение, чем maxBuffers, что полезно для снижения вероятности того, что исходящий обработчик ожидает потоковых данных. В этой ситуации исходящие обработчики блокируются. Исходящая очередь не должна быть пустой.
Credential	Учетные данные — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.
CredentialPolicy	Политика учетных данных, используемая для подписывания запросов HTTP(S) перед отправкой. Это абстрактный класс.
Readable
StorageBrowserPolicy	StorageBrowserPolicy будет обрабатывать различия между Node.js и средой выполнения браузера, включая: Браузеры кэшируют запросы GET/HEAD, добавляя условные заголовки, такие как "IF_MODIFIED_SINCE". StorageBrowserPolicy — это политика, используемая для добавления запроса метки времени в URL-адрес запроса GET/HEAD, поэтому избежать кэша браузера. Удаление заголовка cookie для безопасности Удаление заголовка длины содержимого, чтобы избежать предупреждения браузеров В Node.jsэтот полис является no-op pass-through.
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy.
StorageCRC64Calculator	Класс, используемый для калькулятора контрольной суммы CRC64
StorageRetryPolicy	Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.
StorageRetryPolicyFactory	StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy.
StorageSharedKeyCredential	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с общим ключом.
UserDelegationKeyCredential	ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. UserDelegationKeyCredential используется только для генерации SAS для делегирования пользователей. См. https://learn.microsoft.com/rest/api/storageservices/create-user-delegation-sas

Интерфейсы

NodeJSReadableStream	Node.js доступный destroy для чтения поток, который также имеет метод.
StorageRetryOptions	Интерфейс параметров повторных попыток хранилища BLOB-объектов.
StorageSharedKeyCredentialPolicyOptions	Параметры, используемые для настройки политики StorageSharedKeyCredentialPolicy.
StructuredMessageDecodingStreamOptions	Параметры, используемые при создании StructuredMessageDecodingStream
StructuredMessageEncodingStreamOptions	Опции, используемые при создании StructuredMessageEncodingStream
UserDelegationKey	Ключ для делегирования пользователей.

Псевдонимы типа

CredentialPolicyCreator	Функция фабрики, которая создает новый CredentialPolicy, использующий предоставленный nextPolicy.
OutgoingHandler	OutgoingHandler — это асинхронная функция, активируется BufferScheduler.

Перечисления

StorageRetryPolicyType

Типы RetryPolicy.

Функции

NewRetryPolicyFactory(StorageRetryOptions)	Метод фабрики, используемый для создания фабрики RetryPolicy.
allocBuffer(number)	Выделяет новый нулевый буфер заданного размера.
bufferFromArrayBuffer(ArrayBuffer, number, number)	Создаёт буфер из ArrayBuffer с опциональными смещением и длиной.
createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)	Создаёт Blob из данных данных. Использует косвенную ссылку на конструктора, чтобы обойти ограничительные определения типов Blob от React Native (которые принимают только строки | Blob, а не ArrayBuffer).
getBufferLength(Buffer)	Возвращает длину байта буфера.
getCachedDefaultHttpClient()
isBuffer(unknown)	Проверяет, является ли значение буфером Node.js.
storageBrowserPolicy()	storageBrowserPolicy — это политика, используемая для предотвращения кэширования запросов браузерами и удаления файлов cookie и заголовков с явной длиной содержимого. В Node.jsэтот полис является no-op pass-through.
storageCorrectContentLengthPolicy()	storageCorrectContentLengthPolicy для корректной установки заголовка Content-Length с длиной тела запроса.
storageRequestFailureDetailsParserPolicy()	StorageRequestFailureDetailsParserPolicy
storageRetryPolicy(StorageRetryOptions)	Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.
storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)	storageSharedKeyCredentialPolicy обрабатывает запросы на подпись с помощью ключей учетной записи хранения.
structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)	Для декодирования структурированного тела для проверки содержимого CRC64 при загрузке хранилища.
structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)	Для декодирования структурированного тела для проверки содержимого CRC64 при загрузке хранилища.
structuredMessageEncoding(RequestBodyType, number)	Кодировать структурированное тело для валидации контента CRC64 при загрузке хранилища.

Переменные

storageBrowserPolicyName	Программный идентификатор StorageBrowserPolicy.
storageCorrectContentLengthPolicyName	Программный идентификатор хранилищаCorrectContentLengthPolicy.
storageRequestFailureDetailsParserPolicyName	Программный идентификатор StorageRequestFailureDetailsParserPolicy.
storageRetryPolicyName	Название хранилища RetryPolicy
storageSharedKeyCredentialPolicyName	Программный идентификатор хранилища SharedKeyCredentialPolicy.

Сведения о функции

NewRetryPolicyFactory(StorageRetryOptions)

Метод фабрики, используемый для создания фабрики RetryPolicy.

function NewRetryPolicyFactory(retryOptions?: StorageRetryOptions): RequestPolicyFactory

Параметры

retryOptions

StorageRetryOptions

Возвращаемое значение

RequestPolicyFactory

allocBuffer(number)

Выделяет новый нулевый буфер заданного размера.

function allocBuffer(size: number): NodeBuffer

Параметры

size

number

Возвращаемое значение

NodeBuffer

bufferFromArrayBuffer(ArrayBuffer, number, number)

Создаёт буфер из ArrayBuffer с опциональными смещением и длиной.

function bufferFromArrayBuffer(ab: ArrayBuffer, byteOffset?: number, length?: number): NodeBuffer

Параметры

ab

ArrayBuffer

byteOffset

number

length

number

Возвращаемое значение

NodeBuffer

createBlobFromData(Blob | ArrayBuffer | ArrayBufferView)

Создаёт Blob из данных данных. Использует косвенную ссылку на конструктора, чтобы обойти ограничительные определения типов Blob от React Native (которые принимают только строки | Blob, а не ArrayBuffer).

function createBlobFromData(data: Blob | ArrayBuffer | ArrayBufferView): Blob

Параметры

data

Blob | ArrayBuffer | ArrayBufferView

Возвращаемое значение

Blob

getBufferLength(Buffer)

Возвращает длину байта буфера.

function getBufferLength(buffer: Buffer): number

Параметры

buffer

Buffer

Возвращаемое значение

number

getCachedDefaultHttpClient()

function getCachedDefaultHttpClient(): HttpClient

Возвращаемое значение

HttpClient

isBuffer(unknown)

Проверяет, является ли значение буфером Node.js.

function isBuffer(value: unknown): value

Параметры

value

unknown

Возвращаемое значение

value

storageBrowserPolicy()

storageBrowserPolicy — это политика, используемая для предотвращения кэширования запросов браузерами и удаления файлов cookie и заголовков с явной длиной содержимого.

В Node.jsэтот полис является no-op pass-through.

function storageBrowserPolicy(): PipelinePolicy

Возвращаемое значение

PipelinePolicy

storageCorrectContentLengthPolicy()

storageCorrectContentLengthPolicy для корректной установки заголовка Content-Length с длиной тела запроса.

function storageCorrectContentLengthPolicy(): PipelinePolicy

Возвращаемое значение

PipelinePolicy

storageRequestFailureDetailsParserPolicy()

StorageRequestFailureDetailsParserPolicy

function storageRequestFailureDetailsParserPolicy(): PipelinePolicy

Возвращаемое значение

PipelinePolicy

storageRetryPolicy(StorageRetryOptions)

Политика повторных попыток с экспоненциальной повторными попытками и линейной повторными попытками, реализованной.

function storageRetryPolicy(options?: StorageRetryOptions): PipelinePolicy

Параметры

options

StorageRetryOptions

Возвращаемое значение

PipelinePolicy

storageSharedKeyCredentialPolicy(StorageSharedKeyCredentialPolicyOptions)

storageSharedKeyCredentialPolicy обрабатывает запросы на подпись с помощью ключей учетной записи хранения.

function storageSharedKeyCredentialPolicy(options: StorageSharedKeyCredentialPolicyOptions): PipelinePolicy

Параметры

options

StorageSharedKeyCredentialPolicyOptions

Возвращаемое значение

PipelinePolicy

structuredMessageDecodingBrowser(Blob | ReadableStream<Uint8Array>)

Для декодирования структурированного тела для проверки содержимого CRC64 при загрузке хранилища.

function structuredMessageDecodingBrowser(source: Blob | ReadableStream<Uint8Array>): Promise<Blob>

Параметры

source

Blob | ReadableStream<Uint8Array>

Возвращаемое значение

Promise<Blob>

structuredMessageDecodingStream(ReadableStream, StructuredMessageDecodingStreamOptions)

Для декодирования структурированного тела для проверки содержимого CRC64 при загрузке хранилища.

function structuredMessageDecodingStream(source: ReadableStream, options: StructuredMessageDecodingStreamOptions): NodeJS.ReadableStream

Параметры

source

ReadableStream

options

StructuredMessageDecodingStreamOptions

Возвращаемое значение

NodeJS.ReadableStream

structuredMessageEncoding(RequestBodyType, number)

Кодировать структурированное тело для валидации контента CRC64 при загрузке хранилища.

function structuredMessageEncoding(source: RequestBodyType, contentLength: number): Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Параметры

source

RequestBodyType

contentLength

number

Возвращаемое значение

Promise<{ body: HttpRequestBody, encodedContentLength: number }>

Сведения об переменной

storageBrowserPolicyName

Программный идентификатор StorageBrowserPolicy.

storageBrowserPolicyName: "storageBrowserPolicy"

Тип

"storageBrowserPolicy"

storageCorrectContentLengthPolicyName

Программный идентификатор хранилищаCorrectContentLengthPolicy.

storageCorrectContentLengthPolicyName: "StorageCorrectContentLengthPolicy"

Тип

"StorageCorrectContentLengthPolicy"

storageRequestFailureDetailsParserPolicyName

Программный идентификатор StorageRequestFailureDetailsParserPolicy.

storageRequestFailureDetailsParserPolicyName: "storageRequestFailureDetailsParserPolicy"

Тип

"storageRequestFailureDetailsParserPolicy"

storageRetryPolicyName

Название хранилища RetryPolicy

storageRetryPolicyName: "storageRetryPolicy"

Тип

"storageRetryPolicy"

storageSharedKeyCredentialPolicyName

Программный идентификатор хранилища SharedKeyCredentialPolicy.

storageSharedKeyCredentialPolicyName: "storageSharedKeyCredentialPolicy"

Тип

"storageSharedKeyCredentialPolicy"