DirectoryListHandlesOptionalParams interface

Package:

@azure/storage-file

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
marker	A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.
maxresults	Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
recursive	Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.
sharesnapshot	The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.
timeout	The number of milliseconds a request can take before automatically being terminated.
timeoutParameter	The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

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

Property Value

undefined | [key: string]: string

marker

A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.

marker?: undefined | string

Property Value

undefined | string

maxresults

Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.

maxresults?: undefined | number

Property Value

undefined | number

onDownloadProgress

Callback which fires upon download progress.

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

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

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

Property Value

undefined | (progress: TransferProgressEvent) => void

recursive

Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.

recursive?: undefined | false | true

Property Value

undefined | false | true

sharesnapshot

The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.

sharesnapshot?: undefined | string

Property Value

undefined | string

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: undefined | number

Property Value

undefined | number

timeoutParameter

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.

timeoutParameter?: undefined | number

Property Value

undefined | number