PipelineRequest interface
Metadados sobre uma solicitação que está sendo feita pelo pipeline.
Propriedades
abort |
Usado para anular a solicitação posteriormente. |
agent | SOMENTE NODEJS Uma opção somente de nó para fornecer um personalizado |
allow |
Defina como true se a solicitação for enviada por HTTP em vez de HTTPS |
body | O conteúdo do corpo HTTP (se houver) |
disable |
Se a conexão não deve ser reutilizado. |
enable |
SOMENTE NAVEGADOR Uma opção somente do navegador para habilitar fluxos do navegador. Se essa opção for definida e uma resposta for um fluxo, a resposta terá uma propriedade O valor padrão é false |
form |
Para simular uma postagem de formulário do navegador |
headers | Os cabeçalhos HTTP a serem usados ao fazer a solicitação. |
method | O método HTTP a ser usado ao fazer a solicitação. |
on |
Retorno de chamada que é acionado após o progresso do download. |
on |
Retorno de chamada que é acionado após o progresso do upload. |
proxy |
Configuração de proxy. |
request |
Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento. |
stream |
Uma lista de códigos de status de resposta cujo corpo PipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria tratado como um fluxo. |
timeout | O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.
Se a solicitação for encerrada, um |
tls |
Configurações para configurar a autenticação TLS |
tracing |
Opções de rastreamento a serem usadas para intervalos criados. |
url | A URL para qual será feita a solicitação. |
with |
Indica se o agente do usuário deve enviar cookies do outro domínio no caso de solicitações entre origens. O padrão é false. |
Detalhes da propriedade
abortSignal
Usado para anular a solicitação posteriormente.
abortSignal?: AbortSignalLike
Valor da propriedade
agent
SOMENTE NODEJS
Uma opção somente de nó para fornecer um personalizado http.Agent
/https.Agent
.
Não faz nada ao executar no navegador.
agent?: Agent
Valor da propriedade
allowInsecureConnection
Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
allowInsecureConnection?: boolean
Valor da propriedade
boolean
body
disableKeepAlive
Se a conexão não deve ser reutilizado.
disableKeepAlive?: boolean
Valor da propriedade
boolean
enableBrowserStreams
SOMENTE NAVEGADOR
Uma opção somente do navegador para habilitar fluxos do navegador. Se essa opção for definida e uma resposta for um fluxo, a resposta terá uma propriedade browserStream
em vez da blobBody
qual será indefinida.
O valor padrão é false
enableBrowserStreams?: boolean
Valor da propriedade
boolean
formData
Para simular uma postagem de formulário do navegador
formData?: FormDataMap
Valor da propriedade
headers
Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
headers: HttpHeaders
Valor da propriedade
method
O método HTTP a ser usado ao fazer a solicitação.
method: HttpMethods
Valor da propriedade
onDownloadProgress
Retorno de chamada que é acionado após o progresso do download.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valor da propriedade
(progress: TransferProgressEvent) => void
onUploadProgress
Retorno de chamada que é acionado após o progresso do upload.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valor da propriedade
(progress: TransferProgressEvent) => void
proxySettings
requestId
Um identificador exclusivo para a solicitação. Usado para registro em log e rastreamento.
requestId: string
Valor da propriedade
string
streamResponseStatusCodes
Uma lista de códigos de status de resposta cujo corpo PipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria tratado como um fluxo.
streamResponseStatusCodes?: Set<number>
Valor da propriedade
Set<number>
timeout
O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.
Se a solicitação for encerrada, um AbortError
será gerado.
O padrão é 0, o que desabilita o tempo limite.
timeout: number
Valor da propriedade
number
tlsSettings
Configurações para configurar a autenticação TLS
tlsSettings?: TlsSettings
Valor da propriedade
tracingOptions
Opções de rastreamento a serem usadas para intervalos criados.
tracingOptions?: OperationTracingOptions
Valor da propriedade
url
A URL para qual será feita a solicitação.
url: string
Valor da propriedade
string
withCredentials
Indica se o agente do usuário deve enviar cookies do outro domínio no caso de solicitações entre origens. O padrão é false.
withCredentials: boolean
Valor da propriedade
boolean