WebResourceLike interface
Uma descrição de um pedido HTTP a ser feito num servidor remoto.
Propriedades
abort |
Sinal de um controlador abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta. |
body | O conteúdo do corpo HTTP do pedido. |
decompress |
Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas node-fetch) |
form |
Dados de formulário, utilizados para criar o corpo do pedido. |
headers | Os cabeçalhos HTTP a utilizar ao fazer o pedido. |
keep |
Se a ligação tiver de ser reutilizada. |
method | O método HTTP a utilizar ao fazer o pedido. |
on |
Chamada de retorno que é acionada após o progresso da transferência. |
on |
Chamada de retorno que é acionada após o progresso do carregamento. |
proxy |
Configuração do proxy. |
query | Uma cadeia de consulta representada como um objeto. |
request |
Um identificador exclusivo para o pedido. Utilizado para registo e rastreio. |
stream |
Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo. |
stream |
Uma lista de códigos de estado de resposta cujo corpo httpOperationResponse correspondente deve ser tratado como um fluxo. |
timeout | O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.
Se o pedido for terminado, é emitido um |
url | O URL que está a ser acedido pelo pedido. |
with |
Se as credenciais (cookies) forem enviadas durante um XHR. |
Métodos
clone() | Clone este objeto de pedido. |
prepare(unknown) | Este é um no-op para fins de compatibilidade e será lançado se for chamado. |
validate |
Valida que as propriedades necessárias, como método, URL, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] são definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida. Nota: este é um no-op para fins de compatibilidade. |
Detalhes de Propriedade
abortSignal
Sinal de um controlador abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.
abortSignal?: AbortSignalLike
Valor de Propriedade
body
O conteúdo do corpo HTTP do pedido.
body?: any
Valor de Propriedade
any
decompressResponse
Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas node-fetch)
decompressResponse?: boolean
Valor de Propriedade
boolean
formData
Dados de formulário, utilizados para criar o corpo do pedido.
formData?: any
Valor de Propriedade
any
headers
Os cabeçalhos HTTP a utilizar ao fazer o pedido.
headers: HttpHeadersLike
Valor de Propriedade
keepAlive
Se a ligação tiver de ser reutilizada.
keepAlive?: boolean
Valor de Propriedade
boolean
method
onDownloadProgress
Chamada de retorno que é acionada após o progresso da transferência.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valor de Propriedade
(progress: TransferProgressEvent) => void
onUploadProgress
Chamada de retorno que é acionada após o progresso do carregamento.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valor de Propriedade
(progress: TransferProgressEvent) => void
proxySettings
query
Uma cadeia de consulta representada como um objeto.
query?: {[key: string]: any}
Valor de Propriedade
{[key: string]: any}
requestId
Um identificador exclusivo para o pedido. Utilizado para registo e rastreio.
requestId: string
Valor de Propriedade
string
streamResponseBody
Aviso
Esta API foi preterida.
Use streamResponseStatusCodes property instead.
Se o corpo do HttpOperationResponse deve ou não ser tratado como um fluxo.
streamResponseBody?: boolean
Valor de Propriedade
boolean
streamResponseStatusCodes
Uma lista de códigos de estado de resposta cujo corpo httpOperationResponse correspondente deve ser tratado como um fluxo.
streamResponseStatusCodes?: Set<number>
Valor de Propriedade
Set<number>
timeout
O número de milissegundos que um pedido pode tomar antes de ser terminado automaticamente.
Se o pedido for terminado, é emitido um AbortError
.
timeout: number
Valor de Propriedade
number
url
O URL que está a ser acedido pelo pedido.
url: string
Valor de Propriedade
string
withCredentials
Se as credenciais (cookies) forem enviadas durante um XHR.
withCredentials: boolean
Valor de Propriedade
boolean
Detalhes de Método
clone()
prepare(unknown)
Este é um no-op para fins de compatibilidade e será lançado se for chamado.
function prepare(options: unknown): WebResourceLike
Parâmetros
- options
-
unknown
Devoluções
validateRequestProperties()
Valida que as propriedades necessárias, como método, URL, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] são definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida. Nota: este é um no-op para fins de compatibilidade.
function validateRequestProperties()