@typespec/ts-http-runtime package

Classes

Este erro é gerado quando uma operação assíncrona foi anulada. Verifique esse erro testando a name de que a propriedade name do erro corresponde "AbortError".

Exemplo

import { AbortError } from "@typespec/ts-http-runtime";

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    throw new AbortError();
  }

  // do async work
}

const controller = new AbortController();
controller.abort();

try {
  doAsyncWork({ abortSignal: controller.signal });
} catch (e) {
  if (e instanceof Error && e.name === "AbortError") {
    // handle abort error here.
  }
}

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Interfaces

AddPolicyOptions	Opções ao adicionar uma política ao pipeline. Usado para expressar dependências de outras políticas.
AdditionalPolicyConfig	Usado para configurar políticas adicionais adicionadas ao pipeline na construção.
Agent	Uma interface compatível com o `http.Agent`do NodeJS. Queremos evitar a reexportação pública da interface real, uma vez que ela pode variar entre as versões de tempo de execução.
ApiKeyAuthScheme	Representa o esquema de autenticação de chave de API. A autenticação de chave de API requer que uma chave seja fornecida com cada solicitação. A chave pode ser fornecida em diferentes locais: parâmetro de consulta, cabeçalho ou cookie.
ApiKeyCredential	Credencial para autenticação de chave de API. Fornece uma chave de API que será usada nos cabeçalhos de solicitação.
AuthorizationCodeFlow	Representa a configuração de fluxo do Código de Autorização OAuth2.
BasicAuthScheme	Representa o esquema de autenticação HTTP Basic. O esquema de autenticação básica requer um nome de usuário e senha para ser fornecido com cada solicitação. As credenciais são codificadas usando Base64 e incluídas no cabeçalho Authorization.
BasicCredential	Credencial para autenticação HTTP Básica. Fornece nome de usuário e senha para cabeçalhos de autenticação básica.
BearerAuthScheme	Representa o esquema de autenticação do Portador HTTP. O esquema de autenticação ao portador requer que um token ao portador seja fornecido com cada solicitação. O token é incluído no cabeçalho Authorization com o prefixo "Portador".
BearerTokenCredential	Credencial para autenticação de token de portador.
BodyPart	Uma parte do corpo da solicitação em uma solicitação com várias partes.
Client	Forma de um cliente de nível de descanso
ClientCredentialsFlow	Representa a configuração do fluxo de Credenciais do Cliente OAuth2.
Debugger
FullOperationResponse	Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na propriedade `parsedBody` quando o corpo da resposta é recebido em JSON.
GetBearerTokenOptions	Opções usadas ao criar e enviar solicitações de token get bearer para esta operação.
GetOAuth2TokenOptions	Opções usadas ao criar e enviar solicitações OAuth 2 para esta operação.
HttpClient	A interface necessária para um cliente que faz solicitações HTTP em nome de um pipeline.
HttpHeaders	Representa um conjunto de cabeçalhos HTTP em uma solicitação/resposta. Os nomes de cabeçalho são tratados como insensíveis a maiúsculas e minúsculas.
ImplicitFlow	Representa a configuração de fluxo implícito OAuth2.
KeyObject	Uma interface compatível com o `tls.KeyObject`do NodeJS. Queremos evitar a reexportação pública da interface real, uma vez que ela pode variar entre as versões de tempo de execução.
LogPolicyOptions	Opções para configurar o logPolicy.
MultipartRequestBody	Um corpo de solicitação composto por várias partes.
NoAuthAuthScheme	Representa um ponto de extremidade ou operação que não requer autenticação.
OAuth2AuthScheme	Representa o esquema de autenticação OAuth2 com fluxos especificados
OAuth2TokenCredential	Credencial para fluxos de autenticação OAuth2.
OperationOptions	O tipo de opções base para todas as operações.
OperationRequestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
PasswordFlow	Representa a configuração de fluxo de senha OAuth2.
PathParameterWithOptions	Um objeto que pode ser passado como um parâmetro de caminho, permitindo que opções adicionais sejam definidas relacionadas a como o parâmetro é codificado.
Pipeline	Representa um pipeline para fazer uma solicitação HTTP para uma URL. Os pipelines podem ter várias políticas para gerenciar a manipulação de cada solicitação antes e depois de ela ser feita ao servidor.
PipelineOptions	Define opções que são usadas para configurar o pipeline HTTP para um cliente SDK.
PipelinePolicy	Uma política de pipeline manipula uma solicitação à medida que ela percorre o pipeline. É conceitualmente um middleware que tem permissão para modificar a solicitação antes que ela seja feita, bem como a resposta quando ela é recebida.
PipelineRequest	Metadados sobre uma solicitação que está sendo feita pelo pipeline.
PipelineRequestOptions	Configurações para inicializar uma solicitação. Quase equivalente a Partial<PipelineRequest>, mas url é obrigatório.
PipelineResponse	Metadados sobre uma resposta recebida pelo pipeline.
PipelineRetryOptions	Opções que controlam como repetir solicitações com falha.
ProxySettings	Opções para configurar um proxy para solicitações de saída (somenteNode.js).
PxfObject	Uma interface compatível com o `tls.PxfObject`do NodeJS. Queremos evitar a reexportação pública da interface real, uma vez que ela pode variar entre as versões de tempo de execução.
RedirectPolicyOptions	Opções de como as respostas de redirecionamento são tratadas.
ResourceMethods	Define os métodos que podem ser chamados em um recurso
RestErrorOptions	As opções suportadas por RestError.
TelemetryOptions	Define opções que são usadas para configurar informações comuns de telemetria e rastreamento
TlsSettings	Representa um certificado para autenticação TLS.
UserAgentPolicyOptions	Opções para adicionar detalhes do agente do usuário às solicitações de saída.

Aliases de Tipo

AuthScheme	Tipo de União de todos os sistemas de autenticação suportados
ClientCredential	Tipo de união de todas as credenciais de autenticação suportadas.
ClientOptions	Opções gerais que um cliente de nível de descanso pode tomar
EncodingType	O tipo de codificação de caracteres suportado
FormDataMap	Um objeto simples que fornece dados de formulário, como se fosse de um formulário do navegador.
FormDataValue	Cada entrada de dados de formulário pode ser uma cadeia de caracteres, Blob ou um arquivo. Se você deseja passar um arquivo com um nome, mas não tem acesso à classe File, você pode usar o auxiliar createFile para criar um.
HttpBrowserStreamResponse	Resposta Http qual corpo é um objeto de fluxo NodeJS
HttpMethods	Métodos HTTP suportados para usar ao fazer solicitações.
HttpNodeStreamResponse	Resposta Http qual corpo é um objeto de fluxo NodeJS
HttpResponse	Representa a forma de um HttpResponse
OAuth2Flow	Tipo de união de todos os fluxos OAuth2 suportados
PathParameters	Tipo auxiliar usado para detetar parâmetros em um texto de modelo de caminho cercado por {} será considerado um parâmetro de caminho
PathUnchecked	Define a assinatura para pathUnchecked.
PathUncheckedResponse	Tipo a ser usado com pathUnchecked, substitui o tipo de corpo para qualquer para permitir flexibilidade
PipelinePhase	As políticas são executadas em fases. A ordem de execução é: Fase de serialização Políticas que não estão em fase Fase de desserialização Fase de repetição Fase de Assinatura
RawHttpHeaders	Uma coleção HttpHeaders representada como um objeto JSON simples.
RawHttpHeadersInput	Uma coleção HttpHeaders para entrada, representada como um objeto JSON simples.
RawResponseCallback	Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
RequestBodyType	Tipos de organismos apoiados no pedido. NodeJS.ReadableStream e () => NodeJS.ReadableStream é somente Node. Blob, ReadableStream<Uint8Array> e () => ReadableStream<Uint8Array> são apenas navegadores.
RequestParameters	Forma dos parâmetros de solicitação padrão, isso pode ser substituído pelos tipos de solicitação específicos para fornecer tipos fortes
SendRequest	Uma interface simples para fazer uma solicitação de pipeline e receber uma resposta.
StreamableMethod	Define o tipo para um método que suporta a obtenção do corpo de resposta como um fluxo bruto
TransferProgressEvent	Disparado em resposta ao progresso do upload ou download.
TypeSpecRuntimeClientLogger	Um TypeSpecRuntimeClientLogger é uma função que pode registrar em um nível de gravidade apropriado.
TypeSpecRuntimeLogLevel	Os níveis de log suportados pelo registrador. Os níveis de log na ordem do mais detalhado para o menos detalhado são: verboso informação aviso erro

Funções

TypeSpecRuntimeLogger(any[])	Permite imediatamente o registro em log no nível de log especificado. Se nenhum nível for especificado, o registro em log será desativado.
createDefaultHttpClient()	Crie o HttpClient correto para o ambiente atual.
createEmptyPipeline()	Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.
createHttpHeaders(RawHttpHeadersInput)	Cria um objeto que satisfaz a interface `HttpHeaders`.
createPipelineRequest(PipelineRequestOptions)	Cria uma nova solicitação de pipeline com as opções fornecidas. Este método é para permitir a fácil configuração de valores padrão e não necessário.
createRestError(PathUncheckedResponse)	Cria um erro de repouso a partir de uma resposta PathUnchecked
createRestError(string, PathUncheckedResponse)	Cria um erro de repouso a partir de uma mensagem de erro e uma resposta PathUnchecked
getClient(string, ClientOptions)	Cria um cliente com um pipeline padrão
getLogLevel()	Recupera o nível de log especificado no momento.
isRestError(unknown)	Typeguard para RestError
operationOptionsToRequestParameters(OperationOptions)	Função auxiliar para converter OperationOptions em RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)	Recupera o nível de log especificado no momento.
stringToUint8Array(string, EncodingType)	O auxiliar que transforma a cadeia de caracteres em matriz de bytes codificados por caracteres específicos.
uint8ArrayToString(Uint8Array, EncodingType)	O auxiliar que transforma bytes com codificação de caracteres específicos em cadeia de caracteres

Detalhes de Função

TypeSpecRuntimeLogger(any[])

Permite imediatamente o registro em log no nível de log especificado. Se nenhum nível for especificado, o registro em log será desativado.

function TypeSpecRuntimeLogger(args: any[])

Parâmetros

args: any[]

createDefaultHttpClient()

Crie o HttpClient correto para o ambiente atual.

function createDefaultHttpClient(): HttpClient

Devoluções

HttpClient

createEmptyPipeline()

Cria um pipeline totalmente vazio. Útil para testar ou criar um personalizado.

function createEmptyPipeline(): Pipeline

Devoluções

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Cria um objeto que satisfaz a interface HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parâmetros

rawHeaders: RawHttpHeadersInput

Um objeto simples que representa cabeçalhos iniciais

Devoluções

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

Cria uma nova solicitação de pipeline com as opções fornecidas. Este método é para permitir a fácil configuração de valores padrão e não necessário.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parâmetros

options: PipelineRequestOptions

As opções para criar a solicitação com.

Devoluções

PipelineRequest

createRestError(PathUncheckedResponse)

Cria um erro de repouso a partir de uma resposta PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parâmetros

response: PathUncheckedResponse

Devoluções

RestError

createRestError(string, PathUncheckedResponse)

Cria um erro de repouso a partir de uma mensagem de erro e uma resposta PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

Parâmetros

message: string

response: PathUncheckedResponse

Devoluções

RestError

getClient(string, ClientOptions)

Cria um cliente com um pipeline padrão

function getClient(endpoint: string, clientOptions?: ClientOptions): Client

Parâmetros

endpoint: string

Ponto de extremidade base para o cliente

clientOptions: ClientOptions

Devoluções

Client

getLogLevel()

Recupera o nível de log especificado no momento.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

Devoluções

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e: unknown

Algo apanhado por uma cláusula de captura.

Devoluções

operationOptionsToRequestParameters(OperationOptions)

Função auxiliar para converter OperationOptions em RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parâmetros

options: OperationOptions

as opções que são usadas pela camada modular para enviar a solicitação

Devoluções

RequestParameters

o resultado da conversão em RequestParameters da camada RLC

setLogLevel(TypeSpecRuntimeLogLevel)

Recupera o nível de log especificado no momento.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

Parâmetros

logLevel: TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

O auxiliar que transforma a cadeia de caracteres em matriz de bytes codificados por caracteres específicos.

function stringToUint8Array(value: string, format: EncodingType): Uint8Array

Parâmetros

value: string

a cadeia de caracteres a ser convertida

format: EncodingType

o formato que usamos para decodificar o valor

Devoluções

Uint8Array

um uint8array

uint8ArrayToString(Uint8Array, EncodingType)

O auxiliar que transforma bytes com codificação de caracteres específicos em cadeia de caracteres

function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): string

Parâmetros

bytes: Uint8Array

os bytes uint8array

format: EncodingType

o formato que usamos para codificar o byte

Devoluções

string

uma cadeia de caracteres da cadeia de caracteres codificada

Comentários

Esta página foi útil?

Partilhar via

@typespec/ts-http-runtime package

Classes

Interfaces

Aliases de Tipo

Funções

Detalhes de Função

TypeSpecRuntimeLogger(any[])

Parâmetros

createDefaultHttpClient()

Devoluções

createEmptyPipeline()

Devoluções

createHttpHeaders(RawHttpHeadersInput)

Parâmetros

Devoluções

createPipelineRequest(PipelineRequestOptions)

Parâmetros

Devoluções

createRestError(PathUncheckedResponse)

Parâmetros

Devoluções

createRestError(string, PathUncheckedResponse)

Parâmetros

Devoluções

getClient(string, ClientOptions)

Parâmetros

Devoluções

getLogLevel()

Devoluções

isRestError(unknown)

Parâmetros

Devoluções

operationOptionsToRequestParameters(OperationOptions)

Parâmetros

Devoluções

setLogLevel(TypeSpecRuntimeLogLevel)

Parâmetros

stringToUint8Array(string, EncodingType)

Parâmetros

Devoluções

uint8ArrayToString(Uint8Array, EncodingType)

Parâmetros

Devoluções

Comentários