Поделиться через

@azure/storage-file package

Классы

Aborter

Экземпляр прерывания реализует интерфейс AbortSignal, может прервать HTTP-запросы.

  • Вызовите Aborter.none, чтобы создать новый экземпляр Aborter без времени ожидания.
  • Вызовите Aborter.timeout(), чтобы создать новый экземпляр Aborter с временем ожидания.

Для существующего экземпляра прервано:

  • Вызовите aborter.withTimeout(), чтобы создать и вернуть дочерний экземпляр Aborter с временем ожидания.
  • Вызовите aborter.withValue(key, value), чтобы создать и вернуть дочерний экземпляр Aborter с парой "ключ-значение".
  • Вызовите aborter.abort(), чтобы прервать текущий экземпляр и все дочерние экземпляры.
  • Вызовите aborter.getValue(key) для поиска и получения значения с соответствующим ключом от текущего прерывания для всех родителей.
AccountSASPermissions

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта <xref:IAccountSASSignatureValues>. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
AccountSASResourceTypes

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей ресурсы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений его следует сериализовать с помощью toString и задать поле ресурсов в объекте <xref:IAccountSASSignatureValues>. Можно создать строку ресурсов без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность.
AccountSASServices

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей службы, доступные учетной записью AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит этому службе доступ. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля служб в объекте <xref:IAccountSASSignatureValues>. Можно создать строку служб без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность.
BrowserPolicyFactory

BrowserPolicyFactory — это класс фабрики, помогающий создавать объекты BrowserPolicy.
DirectoryURL

DirectoryURL представляет URL-адрес каталога службы хранилища Azure, позволяющий управлять файлами и каталогами.
FileSASPermissions

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS файлу. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта <xref:IFileSASSignatureValues>. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
FileSystemAttributes

Это вспомогательный класс для создания строки, представляющей атрибуты NTFS для файла или каталога.
FileURL

FileURL представляет URL-адрес файла службы хранилища Azure.
KeepAlivePolicyFactory

KeepAlivePolicyFactory — это класс фабрики, помогающий создавать объекты KeepAlivePolicy.
LoggingPolicyFactory

LoggingPolicyFactory — это класс фабрики, помогающий создавать объекты LoggingPolicy.
Pipeline

Класс Конвейера, содержащий политики HTTP-запроса. Конвейер по умолчанию можно создать, вызвав StorageURL.newPipeline(). Вы также можете создать конвейер с собственными политиками конструктором Конвейера. Перед реализацией настраиваемого конвейера обратитесь к StorageURL.newPipeline() и предоставленным политикам.
RetryPolicyFactory

RetryPolicyFactory — это класс фабрики, помогающий создавать объекты RetryPolicy.
SASQueryParameters

Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами <xref:IAccountSASSignatureValues> и <xref:IFileSASSignatureValues>. После создания его можно закодировать в {@code String} и добавить его непосредственно к URL-адресу (хотя осторожность должна быть предпринята здесь, если существуют существующие параметры запроса, которые могут повлиять на соответствующие средства добавления этих параметров запроса). ПРИМЕЧАНИЕ. Экземпляры этого класса неизменяемы.
ServiceURL

ServiceURL представляет URL-адрес службы файлов службы хранилища Azure, которая позволяет управлять общими папками.
ShareSASPermissions

Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS для общей папки. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта <xref:IFileSASSignatureValues>. Можно создать строку разрешений без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность.
ShareURL

ShareURL представляет URL-адрес общей папки службы хранилища Azure, которая позволяет управлять каталогами и файлами.
StorageURL

ServiceURL представляет класс URL-адреса на основе ServiceURL, ContainerURL и т. д.
TelemetryPolicyFactory

TelemetryPolicyFactory — это класс фабрики, помогающий создавать объекты TelemetryPolicy.
UniqueRequestIDPolicyFactory

UniqueRequestIDPolicyFactory — это класс фабрики, помогающий создавать объекты UniqueRequestIDPolicy.
AnonymousCredential

AnonymousCredential предоставляет элемент credentialPolicyCreator, используемый для создания объектов AnonymousCredentialPolicy. AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
Credential

Учетные данные — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy.
SharedKeyCredential

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. SharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure.
Directory

Класс, представляющий каталог.
File

Класс, представляющий файл.
Service

Класс, представляющий службу.
Share

Класс, представляющий общую папку.
StorageClient
StorageClientContext
AnonymousCredentialPolicy

AnonymousCredentialPolicy используется с запросами HTTP(S), которые считывают общедоступные ресурсы или используются с подписанными URL-адресами (SAS).
BrowserPolicy

BrowserPolicy будет обрабатывать различия между Node.js и средой выполнения браузера, включая:

  1. Браузеры кэшируют запросы GET/HEAD, добавляя условные заголовки, такие как "IF_MODIFIED_SINCE". BrowserPolicy — это политика, используемая для добавления запроса метки времени в URL-адрес запроса GET/HEAD, поэтому избежать кэша браузера.

  2. Удаление заголовка cookie для безопасности

  3. Удаление заголовка длины содержимого, чтобы избежать предупреждения браузеров
CredentialPolicy

Политика учетных данных, используемая для подписывания запросов HTTP(S) перед отправкой. Это абстрактный класс.
KeepAlivePolicy

KeepAlivePolicy — это политика, используемая для управления активными параметрами для каждого запроса.
LoggingPolicy

LogPolicy — это политика, используемая для регистрации запросов.
RetryPolicy

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

SharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с общим ключом.
TelemetryPolicy

TelemetryPolicy — это политика, используемая для тега заголовка агента пользователя для каждого запроса.
UniqueRequestIDPolicy

UniqueRequestIDPolicy создает идентификатор UUID в виде значения заголовка x-ms-request-id.
Batch

Пакетная служба обеспечивает базовое параллельное выполнение с ограничениями параллелизма. Остановится выполнение левых операций, когда одна из выполненных операций выдает ошибку. Но пакетная служба не может отменить текущие операции, их необходимо отменить самостоятельно.
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

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

  1. Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().
  2. Параллелизм должен задать меньшее значение, чем maxBuffers, что полезно для уменьшения возможности ожидания исходящих обработчиков данных потока. В этой ситуации исходящие обработчики блокируются. Исходящая очередь не должна быть пустой.
RetriableReadableStream

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Node.js ReadableStream будет повторно повторяться при неожиданном завершении внутреннего readableStream.

Интерфейсы

IDirectoryCreateOptions
IDirectoryForceCloseHandlesSegmentOptions
IDirectoryListFilesAndDirectoriesSegmentOptions
IDirectoryListHandlesSegmentOptions
IDirectoryProperties
IFileCreateOptions
IFileDownloadOptions
IFileGetRangeListOptions

Параметр определяется как четность с определением REST. Хотя он не готов к использованию сейчас, учитывая, что Crc64 исходного содержимого недоступен.
IFileListHandlesSegmentOptions
IFileProperties
IFileStartCopyOptions
IFileUploadRangeOptions
ISetPropertiesResponse
IAccountSASSignatureValues

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. IAccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызов создаетSASQueryParameters() для получения представления SAS, который можно применить к URL-адресам файлов. Обратите внимание: что этот класс и <xref:SASQueryParameters> существуют, так как первый является мутируемым и логическим представлением, а последний является неизменяемым и используется для создания фактических запросов REST.
IFileSASSignatureValues

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. IFileSASSignatureValues используется для создания маркеров SAS службы файлов для общих ресурсов или файлов.
IIPRange

Допустимый диапазон IP-адресов для SAS.
IRange

Диапазон операций службы.
IKeepAliveOptions

Интерфейс параметров KeepAlivePolicy.
IRequestLogOptions

RequestLogOptions настраивает поведение политики повторных попыток.
IPipelineOptions

Интерфейс параметра для конструктора конвейера.
IRetryOptions

Интерфейс параметров повтора.
IServiceListSharesSegmentOptions
IShareCreateOptions
IShareCreateSnapshotOptions
IShareDeleteMethodOptions
ISignedIdentifier
INewPipelineOptions

Интерфейс параметра для метода Pipeline.newPipeline.
ITelemetryOptions

Интерфейс параметров TelemetryPolicy.
AccessPolicy

Политика доступа.
CorsRule

CORS — это функция HTTP, которая позволяет веб-приложению, работающему под одним доменом, получать доступ к ресурсам в другом домене. Веб-браузеры реализуют ограничение безопасности, известное как политика того же источника, которая запрещает веб-странице вызывать API в другом домене; CORS предоставляет безопасный способ разрешить одному домену (домену-источнику) вызывать API в другом домене.
DirectoryCreateHeaders

Определяет заголовки для операции создания.
DirectoryCreateOptionalParams

Необязательные параметры.
DirectoryDeleteHeaders

Определяет заголовки для операции Delete.
DirectoryDeleteMethodOptionalParams

Необязательные параметры.
DirectoryForceCloseHandlesHeaders

Определяет заголовки для операции ForceCloseHandles.
DirectoryForceCloseHandlesOptionalParams

Необязательные параметры.
DirectoryGetPropertiesHeaders

Определяет заголовки для операции GetProperties.
DirectoryGetPropertiesOptionalParams

Необязательные параметры.
DirectoryItem

Указанный элемент каталога.
DirectoryListFilesAndDirectoriesSegmentHeaders

Определяет заголовки для операции ListFilesAndDirectorySegment.
DirectoryListFilesAndDirectoriesSegmentOptionalParams

Необязательные параметры.
DirectoryListHandlesHeaders

Определяет заголовки для операции ListHandles.
DirectoryListHandlesOptionalParams

Необязательные параметры.
DirectorySetMetadataHeaders

Определяет заголовки для операции SetMetadata.
DirectorySetMetadataOptionalParams

Необязательные параметры.
DirectorySetPropertiesHeaders

Определяет заголовки для операции SetProperties.
DirectorySetPropertiesOptionalParams

Необязательные параметры.
FileAbortCopyHeaders

Определяет заголовки для операции AbortCopy.
FileAbortCopyOptionalParams

Необязательные параметры.
FileCreateHeaders

Определяет заголовки для операции создания.
FileCreateOptionalParams

Необязательные параметры.
FileDeleteHeaders

Определяет заголовки для операции Delete.
FileDeleteMethodOptionalParams

Необязательные параметры.
FileDownloadHeaders

Определяет заголовки для операции загрузки.
FileDownloadOptionalParams

Необязательные параметры.
FileForceCloseHandlesHeaders

Определяет заголовки для операции ForceCloseHandles.
FileForceCloseHandlesOptionalParams

Необязательные параметры.
FileGetPropertiesHeaders

Определяет заголовки для операции GetProperties.
FileGetPropertiesOptionalParams

Необязательные параметры.
FileGetRangeListHeaders

Определяет заголовки для операции GetRangeList.
FileGetRangeListOptionalParams

Необязательные параметры.
FileHTTPHeaders

Дополнительные параметры для набора операций, таких как File_create, File_setHTTPHeaders.
FileItem

Указанный элемент файла.
FileListHandlesHeaders

Определяет заголовки для операции ListHandles.
FileListHandlesOptionalParams

Необязательные параметры.
FileProperty

Свойства файла.
FileSetHTTPHeadersHeaders

Определяет заголовки для операции SetHTTPHeaders.
FileSetHTTPHeadersOptionalParams

Необязательные параметры.
FileSetMetadataHeaders

Определяет заголовки для операции SetMetadata.
FileSetMetadataOptionalParams

Необязательные параметры.
FileStartCopyHeaders

Определяет заголовки для операции StartCopy.
FileStartCopyOptionalParams

Необязательные параметры.
FileUploadRangeFromURLHeaders

Определяет заголовки для операции UploadRangeFromURL.
FileUploadRangeFromURLOptionalParams

Необязательные параметры.
FileUploadRangeHeaders

Определяет заголовки для операции UploadRange.
FileUploadRangeOptionalParams

Необязательные параметры.
FilesAndDirectoriesListSegment

Абстрактная для записей, которые можно перечислить из каталога.
HandleItem

Указанный элемент дескриптора службы хранилища Azure.
ListFilesAndDirectoriesSegmentResponse

Перечисление каталогов и файлов.
ListHandlesResponse

Перечисление дескрипторов.
ListSharesResponse

Перечисление общих папок.
Metrics

Метрики аналитики хранилища для файловой службы.
Permission

Разрешение (дескриптор безопасности), описанное в языке определения дескриптора безопасности (SDDL).
Range

Диапазон файлов службы хранилища Azure.
RetentionPolicy

Политика хранения.
ServiceGetPropertiesHeaders

Определяет заголовки для операции GetProperties.
ServiceGetPropertiesOptionalParams

Необязательные параметры.
ServiceListSharesSegmentHeaders

Определяет заголовки для операции ListSharesSegment.
ServiceListSharesSegmentOptionalParams

Необязательные параметры.
ServiceSetPropertiesHeaders

Определяет заголовки для операции SetProperties.
ServiceSetPropertiesOptionalParams

Необязательные параметры.
ShareCreateHeaders

Определяет заголовки для операции создания.
ShareCreateOptionalParams

Необязательные параметры.
ShareCreatePermissionHeaders

Определяет заголовки для операции CreatePermission.
ShareCreatePermissionOptionalParams

Необязательные параметры.
ShareCreateSnapshotHeaders

Определяет заголовки для операции CreateSnapshot.
ShareCreateSnapshotOptionalParams

Необязательные параметры.
ShareDeleteHeaders

Определяет заголовки для операции Delete.
ShareDeleteMethodOptionalParams

Необязательные параметры.
ShareGetAccessPolicyHeaders

Определяет заголовки для операции GetAccessPolicy.
ShareGetAccessPolicyOptionalParams

Необязательные параметры.
ShareGetPermissionHeaders

Определяет заголовки для операции GetPermission.
ShareGetPermissionOptionalParams

Необязательные параметры.
ShareGetPropertiesHeaders

Определяет заголовки для операции GetProperties.
ShareGetPropertiesOptionalParams

Необязательные параметры.
ShareGetStatisticsHeaders

Определяет заголовки для операции GetStatistics.
ShareGetStatisticsOptionalParams

Необязательные параметры.
ShareItem

Указанный элемент общего ресурса службы хранилища Azure.
ShareProperties

Свойства общей папки.
ShareSetAccessPolicyHeaders

Определяет заголовки для операции SetAccessPolicy.
ShareSetAccessPolicyOptionalParams

Необязательные параметры.
ShareSetMetadataHeaders

Определяет заголовки для операции SetMetadata.
ShareSetMetadataOptionalParams

Необязательные параметры.
ShareSetQuotaHeaders

Определяет заголовки для операции SetQuota.
ShareSetQuotaOptionalParams

Необязательные параметры.
ShareStats

Статистика для общей папки.
SignedIdentifier

Подписанный идентификатор.
SourceModifiedAccessConditions

Дополнительные параметры для операции uploadRangeFromURL.
StorageError

Интерфейс, представляющий StorageError.
StorageServiceProperties

Свойства службы хранилища.
IDownloadFromAzureFileOptions

Интерфейс параметра для DownloadAzurefileToBuffer.
IUploadToAzureFileOptions

Интерфейс параметра для uploadFileToAzureFile и uploadSeekableStreamToAzureFile.
IUploadStreamToAzureFileOptions

Интерфейс параметра для uploadStreamToAzureFile.
IFileAndDirectoryCreateCommonOptions
IFileAndDirectorySetPropertiesCommonOptions
IFileHTTPHeaders
IMetadata
IRetriableReadableStreamOptions

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

FileDownloadResponse

Содержит данные ответа для операции скачивания.
FileGetRangeListResponse

Содержит данные ответа для операции getRangeList.
ShareGetAccessPolicyResponse

Содержит данные ответа для операции getAccessPolicy.
ShareGetStatisticsResponse

Содержит данные ответа для операции getStatistics.
CredentialPolicyCreator

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

Определяет значения для CopyStatusType. Возможные значения включают: "ожидание", "успешно", "прервано", "неудачно"
DeleteSnapshotsOptionType

Определяет значения для DeleteSnapshotsOptionType. Возможные значения: "include"
DirectoryCreateResponse

Содержит данные ответа для операции создания.
DirectoryDeleteResponse

Содержит данные ответа для операции deleteMethod.
DirectoryForceCloseHandlesResponse

Содержит данные ответа для операции forceCloseHandles.
DirectoryGetPropertiesResponse

Содержит данные ответа для операции getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse

Содержит данные ответа для операции listFilesAndDirectorySegment.
DirectoryListHandlesResponse

Содержит данные ответа для операции listHandles.
DirectorySetMetadataResponse

Содержит данные ответа для операции setMetadata.
DirectorySetPropertiesResponse

Содержит данные ответа для операции setProperties.
FileAbortCopyResponse

Содержит данные ответа для операции abortCopy.
FileCreateResponse

Содержит данные ответа для операции создания.
FileDeleteResponse

Содержит данные ответа для операции deleteMethod.
FileForceCloseHandlesResponse

Содержит данные ответа для операции forceCloseHandles.
FileGetPropertiesResponse

Содержит данные ответа для операции getProperties.
FileListHandlesResponse

Содержит данные ответа для операции listHandles.
FileRangeWriteType

Определяет значения для FileRangeWriteType. Возможные значения: "update", "clear"
FileSetHTTPHeadersResponse

Содержит данные ответа для операции setHTTPHeaders.
FileSetMetadataResponse

Содержит данные ответа для операции setMetadata.
FileStartCopyResponse

Содержит данные ответа для операции startCopy.
FileType

Определяет значения для FileType. Возможные значения: "Файл"
FileUploadRangeFromURLResponse

Содержит данные ответа для операции uploadRangeFromURL.
FileUploadRangeResponse

Содержит данные ответа для операции uploadRange.
ListSharesIncludeType

Определяет значения для ListSharesIncludeType. Возможные значения: "моментальные снимки", "метаданные"
ServiceGetPropertiesResponse

Содержит данные ответа для операции getProperties.
ServiceListSharesSegmentResponse

Содержит данные ответа для операции listSharesSegment.
ServiceSetPropertiesResponse

Содержит данные ответа для операции setProperties.
ShareCreatePermissionResponse

Содержит данные ответа для операции createPermission.
ShareCreateResponse

Содержит данные ответа для операции создания.
ShareCreateSnapshotResponse

Содержит данные ответа для операции createSnapshot.
ShareDeleteResponse

Содержит данные ответа для операции deleteMethod.
ShareGetPermissionResponse

Содержит данные ответа для операции getPermission.
ShareGetPropertiesResponse

Содержит данные ответа для операции getProperties.
ShareSetAccessPolicyResponse

Содержит данные ответа для операции setAccessPolicy.
ShareSetMetadataResponse

Содержит данные ответа для операции setMetadata.
ShareSetQuotaResponse

Содержит данные ответа для операции setQuota.
StorageErrorCode

Определяет значения для StorageErrorCode. Возможные значения: AccountAlreadyExists, AccountBeingCreated, AccountIsDisabled, AuthenticationFailed, AuthorizationFailure, ConditionHeadersNotSupported, ConditionNotMet, "EmptyMetadataKey", "InsufficientAccountPermissions", "InternalError", "InvalidAuthenticationInfo", "InvalidHeaderValue", "InvalidHttpVerb", "InvalidInput", "InvalidMd5", "InvalidMetadata", "InvalidQueryParameterValue", "InvalidRange", "InvalidResourceName", "InvalidResourceName", "InvalidMd5", InvalidXmlDocument, InvalidXmlNodeValue, Md5Mismatch, MetadataTooLarge, MissingContentLengthHeader, MissingRequiredQueryParameter, MissingRequiredHeader, MissingRequiredHeader, MissingRequiredXmlNode, "MultipleConditionHeadersNotSupported", "OperationTimedOut", "OutOfRangeInput", "OutOfRangeQueryParameterValue", "RequestBodyTooLarge", "ResourceTypeMismatch", "RequestUrlFailedToParse", "ResourceAlreadyExists", "ResourceNotFound", "ServerBusy", "UnsupportedHeader", " UnsupportedXmlNode, "UnsupportedQueryParameter", "UnsupportedHttpVerb", "CannotDeleteFileOrDirectory", "ClientCacheFlushDelay", "DeletePending", "DirectoryNotEmpty", "FileLockConflict", "InvalidFileOrDirectoryPathName", ParentNotFound, ReadOnlyAttribute, ShareAlreadyExists, ShareBeingDeleted, ShareDisabled, ShareNotFound, ShareNotFound, ShareViolation, ShareSnapshotInProgresss, ShareSnapshotCountExceeded, "ShareSnapshotCountExceeded", "ShareSnapshotOperationNotSupported", " ShareHasSnapshots, ContainerQuotaDowngradeNotAllowed
FileAttributesPreserveType

Указывает, что существующие атрибуты файла не изменяются.
FilePermissionInheritType

Указывает наследование разрешения файла от родительского каталога.
FilePermissionPreserveType

Указывает, что существующее значение разрешения файла не изменяется.
TimeNowType

Указывает параметр в качестве времени запроса.
TimePreserveType

Указывает, что существующее значение времени не изменяется.
Operation

Операция — это асинхронная функция для выполнения и управления с помощью пакетной службы.
OutgoingHandler

OutgoingHandler — это асинхронная функция, активируется BufferScheduler.
ReadableStreamGetter

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

SASProtocol

Протоколы для созданного SAS.
RetryPolicyType

Типы RetryPolicy.

Функции

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект <xref:SASQueryParameters>, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.
generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters.

Принимает только необходимые параметры для создания SAS. Для дополнительных параметров задайте соответствующие свойства напрямую, например разрешения, startTime и идентификатор.

ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истечению срока действия & разрешения вручную, если вы инициалы с помощью этого конструктора.
ipRangeToString(IIPRange)

Создайте строку формата IPRange. Например: "8.8.8.8" или "1.1.1.1-255.255.255.255.255"
rangeToString(IRange)

Создайте строку диапазона. Например: "bytes=255-" или "bytes=0-511"
uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ. Отправляет объект BLOB-объекта браузера,File/ArrayBuffer/ArrayBufferView в файл Azure.
downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Загружает файл Azure параллельно с буфером. Смещение и число являются необязательными, передайте 0 для скачивания всего файла.
uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет локальный файл в файл Azure.
uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет Node.js доступный для чтения поток в файл Azure. Этот метод попытается создать Azure, а затем начнет отправлять блоки по блоку. Размер блока определяется параметром bufferSize. Убедитесь, что потенциальный размер потока не превышает размер файла.

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

  • Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().
fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType)
fileCreationTimeToString(Date | TimeNowType | TimePreserveType)
fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType)
validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions)
validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions)
validateFilePermissionOptions(undefined | string, undefined | string)
NewRetryPolicyFactory(IRetryOptions)

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

Преобразуйте объект BLOB-объекта браузера в ArrayBuffer.
appendToURLPath(string, string)

Добавьте строку к URL-пути. Удаляет повторяющийся "/" перед строкой, когда путь URL-адреса заканчивается словом "/".
base64decode(string)

Декодирование Base64.
base64encode(string)

Кодировка Base64.
delay(number, AbortSignalLike, Error)

Задержка указанного интервала времени.
escapeURLPath(string)

Зарезервированные символы URL-адреса должны быть правильно экранированы для служб хранилища, таких как BLOB-объект или файл.

Стратегия кодирования URL-адресов и escape-адресов для пакетов SDK JSv10

Когда клиенты передают строку URL-адреса в конструктор классов XXXURL, строка URL-адреса уже может быть закодирована или нет. Но перед отправкой на сервер службы хранилища Azure URL-адрес должен быть закодирован. Однако для пакета SDK трудно угадать, была ли строка URL-адреса закодирована или нет. У нас есть 2 потенциальных стратегия и выбрана стратегия для конструкторов XXXURL.

Стратегия. Предположим, что строка URL-адреса клиента не закодирована и всегда кодирует строку URL-адреса в пакете SDK.

Это то, что делает устаревший пакет SDK версии 2, простой и работает в большинстве случаев.

  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b:", пакет SDK закодирует его в "http://account.blob.core.windows.net/con/b%3A" и отправка на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%3A", пакет SDK закодирует его в "http://account.blob.core.windows.net/con/b%253A" и отправка на сервер. Будет создан большой двоичный объект с именем "b%3A".

Но эта стратегия сделает невозможным создать большой двоичный объект с "?" в его имени. Так как при строке URL-адреса клиентаhttp://account.blob.core.windows.net/con/blob?name", имя "?name" будет рассматриваться как параметр URL-адреса вместо имени большого двоичного объекта. Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/blob%3Fname", будет создан большой двоичный объект с именем "BLOB-объект%3Fname". Пакет SDK версии 2 не имеет этой проблемы, так как он не разрешает клиенту передавать полный URL-адрес, он принимает отдельное имя большого двоичного объекта и кодированиеURIComponent для него. Невозможно принять пакет SDK для создания имени большого двоичного объекта с помощью "?". Поэтому мы реализуем стратегию два:

Стратегия 2. Пакет SDK не предполагает, что URL-адрес закодирован или нет. Он просто экранирует специальные символы.

Это то, что делает пакет SDK для Blob Go версии 10. Он принимает тип URL-адреса в Go и URL-адрес вызова. EscapedPath() для того чтобы избежать специальных символов, незакрытых.

  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b:", пакет SDK будет экранировать ":" например"http://account.blob.core.windows.net/con/b%3A" и отправка на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%3A", нет специальных символов, поэтому отправлять "http://account.blob.core.windows.net/con/b%3A" на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%253A", нет специальных символов, поэтому отправлять "http://account.blob.core.windows.net/con/b%253A" на сервер. Будет создан большой двоичный объект с именем "b%3A".

Эта стратегия дает нам гибкость для создания с помощью любых специальных символов. Но "%" будет рассматриваться как специальные символы, если строка URL-адреса не закодирована, не должно быть "%" в строке URL-адреса, в противном случае URL-адрес не является допустимым URL-адресом. Если клиенту нужно создать большой двоичный объект с "%" в его имени большого двоичного объекта, используйте "%25" insead "%". Как и выше, 3-й пример. И следующие строки URL-адресов недопустимы.

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Другой специальный символ — "?", используйте "%2F" для представления имени большого двоичного объекта с "?" в строке URL-адреса.

Стратегия для контейнераName, BLOBName или других конкретных параметров XXXName в таких методах, как BlobURL.fromContainerURL(containerURL, blobName)

Мы применим стратегию, и вызовем кодированиеURIComponent для этих параметров, таких как blobName. Так как клиенты передают это простое имя вместо URL-адреса.
getURLParameter(string, string)

Получение параметра URL-адреса по имени.
getURLPath(string)

Путь URL-адреса из строки URL-адреса.
getURLQueries(string)

Получение пар значений ключа запроса URL-адреса из строки URL-адреса.
padStart(string, number, undefined | string)

String.prototype.padStart()
setURLHost(string, string)

Задайте узел URL-адреса.
setURLParameter(string, string, undefined | string)

Задайте имя и значение параметра URL-адреса. Если имя существует в параметрах URL-адреса, старое значение будет заменено ключом имени. Если значение не указано, параметр будет удален.
truncatedISO8061Date(Date, undefined | false | true)

Округляет дату от секунд.
streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Считывает доступный для чтения поток в буфер. Заполните буфер из смещения в конец.

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

generateAccountSASQueryParameters(IAccountSASSignatureValues, SharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект <xref:SASQueryParameters>, содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.

function generateAccountSASQueryParameters(accountSASSignatureValues: IAccountSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Параметры

accountSASSignatureValues
IAccountSASSignatureValues
sharedKeyCredential
SharedKeyCredential

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

SASQueryParameters

generateFileSASQueryParameters(IFileSASSignatureValues, SharedKeyCredential)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters.

Принимает только необходимые параметры для создания SAS. Для дополнительных параметров задайте соответствующие свойства напрямую, например разрешения, startTime и идентификатор.

ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истечению срока действия & разрешения вручную, если вы инициалы с помощью этого конструктора.

function generateFileSASQueryParameters(fileSASSignatureValues: IFileSASSignatureValues, sharedKeyCredential: SharedKeyCredential)

Параметры

fileSASSignatureValues
IFileSASSignatureValues
sharedKeyCredential
SharedKeyCredential

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

SASQueryParameters

ipRangeToString(IIPRange)

Создайте строку формата IPRange. Например: "8.8.8.8" или "1.1.1.1-255.255.255.255.255"

function ipRangeToString(ipRange: IIPRange)

Параметры

ipRange
IIPRange

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

string

rangeToString(IRange)

Создайте строку диапазона. Например: "bytes=255-" или "bytes=0-511"

function rangeToString(iRange: IRange)

Параметры

iRange
IRange

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

string

uploadBrowserDataToAzureFile(Aborter, Blob | ArrayBuffer | ArrayBufferView, FileURL, IUploadToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В БРАУЗЕРАХ. Отправляет объект BLOB-объекта браузера,File/ArrayBuffer/ArrayBufferView в файл Azure.

function uploadBrowserDataToAzureFile(aborter: Aborter, browserData: Blob | ArrayBuffer | ArrayBufferView, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Параметры

aborter
Aborter

Создание нового экземпляра Aborter с помощью Aborter.none или Aborter.timeout(), документов goto Aborter для получения дополнительных примеров об отмене запроса

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer или ArrayBufferView

fileURL
FileURL
options
IUploadToAzureFileOptions

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

Promise<void>

downloadAzureFileToBuffer(Aborter, Buffer, FileURL, number, undefined | number, IDownloadFromAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Загружает файл Azure параллельно с буфером. Смещение и число являются необязательными, передайте 0 для скачивания всего файла.

function downloadAzureFileToBuffer(aborter: Aborter, buffer: Buffer, fileURL: FileURL, offset: number, count?: undefined | number, options?: IDownloadFromAzureFileOptions)

Параметры

aborter
Aborter

Создание нового экземпляра Aborter с помощью Aborter.none или Aborter.timeout(), документов goto Aborter для получения дополнительных примеров об отмене запроса

buffer

Buffer

Буфер для заполнения должен иметь длину больше, чем число

fileURL
FileURL

Объект FileURL

offset

number

С какой позиции файла Azure для скачивания

count

undefined | number

options
IDownloadFromAzureFileOptions

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

Promise<void>

uploadFileToAzureFile(Aborter, string, FileURL, IUploadToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет локальный файл в файл Azure.

function uploadFileToAzureFile(aborter: Aborter, filePath: string, fileURL: FileURL, options?: IUploadToAzureFileOptions)

Параметры

aborter
Aborter

Создание нового экземпляра Aborter с помощью Aborter.none или Aborter.timeout(), документов goto Aborter для получения дополнительных примеров об отмене запроса

filePath

string

Полный путь к локальному файлу

fileURL
FileURL

FileURL

options
IUploadToAzureFileOptions

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

Promise<void>

uploadStreamToAzureFile(Aborter, Readable, number, FileURL, number, number, IUploadStreamToAzureFileOptions)

ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Отправляет Node.js доступный для чтения поток в файл Azure. Этот метод попытается создать Azure, а затем начнет отправлять блоки по блоку. Размер блока определяется параметром bufferSize. Убедитесь, что потенциальный размер потока не превышает размер файла.

СОВЕТЫ ПО УЛУЧШЕНИЮ ПРОИЗВОДИТЕЛЬНОСТИ:

  • Входной поток highWaterMark лучше задать то же значение с параметром bufferSize, что позволит избежать операций Buffer.concat().
function uploadStreamToAzureFile(aborter: Aborter, stream: Readable, size: number, fileURL: FileURL, bufferSize: number, maxBuffers: number, options?: IUploadStreamToAzureFileOptions)

Параметры

aborter
Aborter

Создание нового экземпляра Aborter с помощью Aborter.none или Aborter.timeout(), документов goto Aborter для получения дополнительных примеров об отмене запроса

stream

Readable

Node.js доступный для чтения поток. Должно быть меньше или равно размеру файла.

size

number

Размер создаваемого файла. Допустимый максимальный размер — 1 ТБ. Если это значение больше размера потока, то в хвосте файла будут пустые байты.

fileURL
FileURL

Экземпляр FileURL

bufferSize

number

Размер каждого буфера, выделенного в байтах, также размер блока или диапазона во время отправленного файла. Размер должен быть > 0 и <= 4 * 1024 * 1024 (4 МБ)

maxBuffers

number

Максимальное количество буферов выделяется во время отправки, положительная корреляция с максимальной загрузкой параллелизма

options
IUploadStreamToAzureFileOptions

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

Promise<void>

fileAttributesToString(FileSystemAttributes | FileAttributesPreserveType) 

function fileAttributesToString(fileAttributes: FileSystemAttributes | FileAttributesPreserveType)

Параметры

fileAttributes

FileSystemAttributes | FileAttributesPreserveType

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

string

fileCreationTimeToString(Date | TimeNowType | TimePreserveType) 

function fileCreationTimeToString(time: Date | TimeNowType | TimePreserveType)

Параметры

time

Date | TimeNowType | TimePreserveType

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

string

fileLastWriteTimeToString(Date | TimeNowType | TimePreserveType) 

function fileLastWriteTimeToString(time: Date | TimeNowType | TimePreserveType)

Параметры

time

Date | TimeNowType | TimePreserveType

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

string

validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(IFileAndDirectoryCreateCommonOptions) 

function validateAndSetDefaultsForFileAndDirectoryCreateCommonOptions(options: IFileAndDirectoryCreateCommonOptions)

Параметры

options
IFileAndDirectoryCreateCommonOptions

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

IFileAndDirectoryCreateCommonOptions

validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(IFileAndDirectorySetPropertiesCommonOptions) 

function validateAndSetDefaultsForFileAndDirectorySetPropertiesCommonOptions(options: IFileAndDirectorySetPropertiesCommonOptions)

Параметры

options
IFileAndDirectorySetPropertiesCommonOptions

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

IFileAndDirectorySetPropertiesCommonOptions

validateFilePermissionOptions(undefined | string, undefined | string) 

function validateFilePermissionOptions(filePermission?: undefined | string, filePermissionKey?: undefined | string)

Параметры

filePermission

undefined | string

filePermissionKey

undefined | string

NewRetryPolicyFactory(IRetryOptions)

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

function NewRetryPolicyFactory(retryOptions?: IRetryOptions)

Параметры

retryOptions
IRetryOptions

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

RequestPolicyFactory

blobToArrayBuffer(Blob)

Преобразуйте объект BLOB-объекта браузера в ArrayBuffer.

function blobToArrayBuffer(blob: Blob)

Параметры

blob

Blob

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

Promise<ArrayBuffer>

appendToURLPath(string, string)

Добавьте строку к URL-пути. Удаляет повторяющийся "/" перед строкой, когда путь URL-адреса заканчивается словом "/".

function appendToURLPath(url: string, name: string)

Параметры

url

string

Строка исходного URL-адреса

name

string

Строка, добавляемая к URL-адресу

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

string

Обновленная строка URL-адреса

base64decode(string)

Декодирование Base64.

function base64decode(encodedString: string)

Параметры

encodedString

string

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

string

base64encode(string)

Кодировка Base64.

function base64encode(content: string)

Параметры

content

string

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

string

delay(number, AbortSignalLike, Error)

Задержка указанного интервала времени.

function delay(timeInMs: number, aborter?: AbortSignalLike, abortError?: Error)

Параметры

timeInMs

number

aborter

AbortSignalLike

abortError

Error

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

Promise<unknown>

escapeURLPath(string)

Зарезервированные символы URL-адреса должны быть правильно экранированы для служб хранилища, таких как BLOB-объект или файл.

Стратегия кодирования URL-адресов и escape-адресов для пакетов SDK JSv10

Когда клиенты передают строку URL-адреса в конструктор классов XXXURL, строка URL-адреса уже может быть закодирована или нет. Но перед отправкой на сервер службы хранилища Azure URL-адрес должен быть закодирован. Однако для пакета SDK трудно угадать, была ли строка URL-адреса закодирована или нет. У нас есть 2 потенциальных стратегия и выбрана стратегия для конструкторов XXXURL.

Стратегия. Предположим, что строка URL-адреса клиента не закодирована и всегда кодирует строку URL-адреса в пакете SDK.

Это то, что делает устаревший пакет SDK версии 2, простой и работает в большинстве случаев.

  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b:", пакет SDK закодирует его в "http://account.blob.core.windows.net/con/b%3A" и отправка на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%3A", пакет SDK закодирует его в "http://account.blob.core.windows.net/con/b%253A" и отправка на сервер. Будет создан большой двоичный объект с именем "b%3A".

Но эта стратегия сделает невозможным создать большой двоичный объект с "?" в его имени. Так как при строке URL-адреса клиентаhttp://account.blob.core.windows.net/con/blob?name", имя "?name" будет рассматриваться как параметр URL-адреса вместо имени большого двоичного объекта. Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/blob%3Fname", будет создан большой двоичный объект с именем "BLOB-объект%3Fname". Пакет SDK версии 2 не имеет этой проблемы, так как он не разрешает клиенту передавать полный URL-адрес, он принимает отдельное имя большого двоичного объекта и кодированиеURIComponent для него. Невозможно принять пакет SDK для создания имени большого двоичного объекта с помощью "?". Поэтому мы реализуем стратегию два:

Стратегия 2. Пакет SDK не предполагает, что URL-адрес закодирован или нет. Он просто экранирует специальные символы.

Это то, что делает пакет SDK для Blob Go версии 10. Он принимает тип URL-адреса в Go и URL-адрес вызова. EscapedPath() для того чтобы избежать специальных символов, незакрытых.

  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b:", пакет SDK будет экранировать ":" например"http://account.blob.core.windows.net/con/b%3A" и отправка на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%3A", нет специальных символов, поэтому отправлять "http://account.blob.core.windows.net/con/b%3A" на сервер. Будет создан большой двоичный объект с именем "b:".
  • Если строка URL-адреса клиента имеет значение "http://account.blob.core.windows.net/con/b%253A", нет специальных символов, поэтому отправлять "http://account.blob.core.windows.net/con/b%253A" на сервер. Будет создан большой двоичный объект с именем "b%3A".

Эта стратегия дает нам гибкость для создания с помощью любых специальных символов. Но "%" будет рассматриваться как специальные символы, если строка URL-адреса не закодирована, не должно быть "%" в строке URL-адреса, в противном случае URL-адрес не является допустимым URL-адресом. Если клиенту нужно создать большой двоичный объект с "%" в его имени большого двоичного объекта, используйте "%25" insead "%". Как и выше, 3-й пример. И следующие строки URL-адресов недопустимы.

  • "http://account.blob.core.windows.net/con/b%"
  • "http://account.blob.core.windows.net/con/b%2"
  • "http://account.blob.core.windows.net/con/b%G"

Другой специальный символ — "?", используйте "%2F" для представления имени большого двоичного объекта с "?" в строке URL-адреса.

Стратегия для контейнераName, BLOBName или других конкретных параметров XXXName в таких методах, как BlobURL.fromContainerURL(containerURL, blobName)

Мы применим стратегию, и вызовем кодированиеURIComponent для этих параметров, таких как blobName. Так как клиенты передают это простое имя вместо URL-адреса.

function escapeURLPath(url: string)

Параметры

url

string

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

string

getURLParameter(string, string)

Получение параметра URL-адреса по имени.

function getURLParameter(url: string, name: string)

Параметры

url

string

name

string

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

string | string[] | undefined

getURLPath(string)

Путь URL-адреса из строки URL-адреса.

function getURLPath(url: string)

Параметры

url

string

Строка исходного URL-адреса

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

string | undefined

getURLQueries(string)

Получение пар значений ключа запроса URL-адреса из строки URL-адреса.

function getURLQueries(url: string)

Параметры

url

string

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

[key: string]: string

padStart(string, number, undefined | string)

String.prototype.padStart()

function padStart(currentString: string, targetLength: number, padString?: undefined | string)

Параметры

currentString

string

targetLength

number

padString

undefined | string

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

string

setURLHost(string, string)

Задайте узел URL-адреса.

function setURLHost(url: string, host: string)

Параметры

url

string

Строка исходного URL-адреса

host

string

Новая строка узла

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

string

Обновленная строка URL-адреса

setURLParameter(string, string, undefined | string)

Задайте имя и значение параметра URL-адреса. Если имя существует в параметрах URL-адреса, старое значение будет заменено ключом имени. Если значение не указано, параметр будет удален.

function setURLParameter(url: string, name: string, value?: undefined | string)

Параметры

url

string

Строка исходного URL-адреса

name

string

Имя параметра

value

undefined | string

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

string

Обновленная строка URL-адреса

truncatedISO8061Date(Date, undefined | false | true)

Округляет дату от секунд.

function truncatedISO8061Date(date: Date, withMilliseconds?: undefined | false | true)

Параметры

date

Date

withMilliseconds

undefined | false | true

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

string

Строка даты в формате ISO8061 с компонентом 7 миллисекунда или без нее

streamToBuffer(ReadableStream, Buffer, number, number, undefined | string)

Считывает доступный для чтения поток в буфер. Заполните буфер из смещения в конец.

function streamToBuffer(stream: ReadableStream, buffer: Buffer, offset: number, end: number, encoding?: undefined | string)

Параметры

stream

ReadableStream

Поток Node.js для чтения

buffer

Buffer

Заполненный буфер, длина должна >= смещение

offset

number

От какого положения в буфере должно быть заполнено, включительно

end

number

Какая позиция в буфере должна быть заполнена, эксклюзивная

encoding

undefined | string

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

Promise<void>