FileDownloadToBufferOptions interface

Pacote:

@azure/storage-file-share

Interface de opção para a downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions) operação.

Extends

CommonOptions

Propriedades

abortSignal	Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.
concurrency	A simultaneidade indica o número máximo de intervalos a serem baixados em paralelo. Se não for fornecido, 5 simultaneidades serão usadas por padrão.
leaseAccessConditions	Condições de acesso de concessão.
maxRetryRequestsPerRange	Opcional. DISPONÍVEL APENAS EM NODE.JS. Quantas novas tentativas serão executadas quando o fluxo de download do intervalo original terminar inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede. Com essa opção, cada repetição adicional significa que uma solicitação adicional shareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequestsPerRange seja atingido. O valor padrão é 5, defina um valor maior quando estiver em uma rede ruim.
onProgress	Atualizador de progresso.
rangeSize	Ao baixar arquivos do Azure, o método de download tentará dividir um arquivo grande em intervalos pequenos. Cada intervalo pequeno será baixado por meio de uma solicitação separada. Essa opção define dados de tamanho a cada solicitação pequena que tenta baixar. Deve ser maior que 0, usará o valor padrão se indefinido,

Propriedades herdadas

tracingOptions

Detalhes da propriedade

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

concurrency

A simultaneidade indica o número máximo de intervalos a serem baixados em paralelo. Se não for fornecido, 5 simultaneidades serão usadas por padrão.

concurrency?: number

Valor da propriedade

number

leaseAccessConditions

Condições de acesso de concessão.

leaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

LeaseAccessConditions

maxRetryRequestsPerRange

Opcional. DISPONÍVEL APENAS EM NODE.JS. Quantas novas tentativas serão executadas quando o fluxo de download do intervalo original terminar inesperadamente. O tipo acima de extremidades não disparará a política de repetição definida em um pipeline, pois elas não emitem erros de rede.

Com essa opção, cada repetição adicional significa que uma solicitação adicional shareFileClient.download() será feita a partir do ponto interrompido, até que o intervalo solicitado tenha sido baixado com êxito ou maxRetryRequestsPerRange seja atingido.

O valor padrão é 5, defina um valor maior quando estiver em uma rede ruim.

maxRetryRequestsPerRange?: number

Valor da propriedade

number

onProgress

Atualizador de progresso.

onProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

rangeSize

Ao baixar arquivos do Azure, o método de download tentará dividir um arquivo grande em intervalos pequenos. Cada intervalo pequeno será baixado por meio de uma solicitação separada. Essa opção define dados de tamanho a cada solicitação pequena que tenta baixar. Deve ser maior que 0, usará o valor padrão se indefinido,

rangeSize?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

tracingOptions

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado deCommonOptions.tracingOptions