DirectoryListFilesAndDirectoriesOptions interface

Package:

@azure/storage-file-share

Options to configure listFilesAndDirectories operation.

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
includeAttributes
includeEtag
includeExtendedInfo	Optional. Specified that extended info should be included in the returned FileItem or DirectoryItem. If true, the Content-Length property will be up-to-date, FileId will be returned in response.
includePermissionKey
includeTimestamps
prefix	Filters the results to return only entries whose name begins with the specified prefix.

Inherited Properties

tracingOptions

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

includeAttributes

includeAttributes?: boolean

Property Value

boolean

includeEtag

includeEtag?: boolean

Property Value

boolean

includeExtendedInfo

Optional. Specified that extended info should be included in the returned FileItem or DirectoryItem. If true, the Content-Length property will be up-to-date, FileId will be returned in response.

includeExtendedInfo?: boolean

Property Value

boolean

includePermissionKey

includePermissionKey?: boolean

Property Value

boolean

includeTimestamps

includeTimestamps?: boolean

Property Value

boolean

prefix

Filters the results to return only entries whose name begins with the specified prefix.

prefix?: string

Property Value

string

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions