DirectoryListHandlesOptionalParams interface

Пакет:

@azure/storage-file

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

Extends

RequestOptionsBase

Свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
customHeaders	{object} [customHeaders] Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
marker	Строковое значение, определяющее часть списка, возвращаемую с помощью следующей операции списка. Операция возвращает значение маркера в теле ответа, если возвращенный список не был завершен. Затем значение маркера может использоваться при последующем вызове для запроса следующего набора элементов списка. Значение маркера непрозрачно для клиента.
maxresults	Указывает максимальное количество возвращаемых записей. Если запрос не задает maxresults или задает значение, превышающее 5000, сервер вернет до 5000 элементов.
onDownloadProgress	Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
recursive	Указывает, что операция должна применяться к каталогу, указанному в URI, его файлам, его подкаталогам и их файлам.
sharesnapshot	Параметр моментального снимка — это непрозрачное значение DateTime, указывающее моментальный снимок общего ресурса для запроса.
timeout	Число миллисекундах запроса может приниматься перед автоматическим завершением.
timeoutParameter	Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов.

Сведения о свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

customHeaders

{object} [customHeaders] Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: undefined | [key: string]: string

Значение свойства

undefined | [key: string]: string

marker

Строковое значение, определяющее часть списка, возвращаемую с помощью следующей операции списка. Операция возвращает значение маркера в теле ответа, если возвращенный список не был завершен. Затем значение маркера может использоваться при последующем вызове для запроса следующего набора элементов списка. Значение маркера непрозрачно для клиента.

marker?: undefined | string

Значение свойства

undefined | string

maxresults

Указывает максимальное количество возвращаемых записей. Если запрос не задает maxresults или задает значение, превышающее 5000, сервер вернет до 5000 элементов.

maxresults?: undefined | number

Значение свойства

undefined | number

onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Значение свойства

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Значение свойства

undefined | (progress: TransferProgressEvent) => void

recursive

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

recursive?: undefined | false | true

Значение свойства

undefined | false | true

sharesnapshot

Параметр моментального снимка — это непрозрачное значение DateTime, указывающее моментальный снимок общего ресурса для запроса.

sharesnapshot?: undefined | string

Значение свойства

undefined | string

timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением.

timeout?: undefined | number

Значение свойства

undefined | number

timeoutParameter

Параметр времени ожидания выражается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций службы файлов.

timeoutParameter?: undefined | number

Значение свойства

undefined | number