@typespec/ts-http-runtime package

Clases

Este error se produce cuando se ha anulado una operación asincrónica. Compruebe este error probando el name que la propiedad name del error coincide con "AbortError".

Ejemplo

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

Tipo de error personalizado para solicitudes de canalización con error.

Interfaces

AddPolicyOptions	Opciones al agregar una directiva a la canalización. Se usa para expresar dependencias en otras directivas.
AdditionalPolicyConfig	Se usa para configurar directivas adicionales agregadas a la canalización en la construcción.
Agent	Interfaz compatible con el `http.Agent`de NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
ApiKeyAuthScheme	Representa el esquema de autenticación de clave de API. La autenticación de clave de API requiere que se proporcione una clave con cada solicitud. La clave se puede proporcionar en diferentes ubicaciones: parámetro de consulta, encabezado o cookie.
ApiKeyCredential	Credencial para la autenticación de clave de API. Proporciona una clave de API que se usará en los encabezados de la solicitud.
AuthorizationCodeFlow	Representa la configuración de flujo de código de autorización de OAuth2.
BasicAuthScheme	Representa el esquema de autenticación HTTP Basic. El esquema de autenticación básico requiere que se proporcione un nombre de usuario y una contraseña con cada solicitud. Las credenciales se codifican mediante Base64 y se incluyen en el encabezado de autorización.
BasicCredential	Credencial para la autenticación básica HTTP. Proporciona nombre de usuario y contraseña para encabezados de autenticación básicos.
BearerAuthScheme	Representa el esquema de autenticación del portador HTTP. El esquema de autenticación de portador requiere que se proporcione un token de portador con cada solicitud. El token se incluye en el encabezado de autorización con el prefijo "Bearer".
BearerTokenCredential	Credencial para la autenticación del token de portador.
BodyPart	Parte del cuerpo de la solicitud en una solicitud de varias partes.
Client	Forma de un cliente de nivel de rest
ClientCredentialsFlow	Representa la configuración del flujo de credenciales de cliente de OAuth2.
Debugger
FullOperationResponse	Objeto contenedor para la solicitud y respuesta http. El objeto deserializado se almacena en la propiedad `parsedBody` cuando se recibe el cuerpo de la respuesta en JSON.
GetBearerTokenOptions	Opciones utilizadas al crear y enviar solicitudes de token de portador get para esta operación.
GetOAuth2TokenOptions	Opciones utilizadas al crear y enviar solicitudes get OAuth 2 para esta operación.
HttpClient	Interfaz necesaria para un cliente que realiza solicitudes HTTP en nombre de una canalización.
HttpHeaders	Representa un conjunto de encabezados HTTP en una solicitud o respuesta. Los nombres de encabezado se tratan como no distinguen mayúsculas de minúsculas.
ImplicitFlow	Representa la configuración de flujo implícito de OAuth2.
KeyObject	Interfaz compatible con el `tls.KeyObject`de NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
LogPolicyOptions	Opciones para configurar logPolicy.
MultipartRequestBody	Cuerpo de la solicitud que consta de varias partes.
NoAuthAuthScheme	Representa un punto de conexión u operación que no requiere autenticación.
OAuth2AuthScheme	Representa el esquema de autenticación de OAuth2 con flujos especificados
OAuth2TokenCredential	Credencial para flujos de autenticación de OAuth2.
OperationOptions	Tipo de opciones base para todas las operaciones.
OperationRequestOptions	Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
PasswordFlow	Representa la configuración del flujo de contraseñas de OAuth2.
PathParameterWithOptions	Objeto que se puede pasar como parámetro de ruta de acceso, lo que permite establecer opciones adicionales relacionadas con cómo se codifica el parámetro.
Pipeline	Representa una canalización para realizar una solicitud HTTP en una dirección URL. Las canalizaciones pueden tener varias directivas para administrar la manipulación de cada solicitud antes y después de realizarla en el servidor.
PipelineOptions	Define las opciones que se usan para configurar la canalización HTTP para un cliente del SDK.
PipelinePolicy	Una directiva de canalización manipula una solicitud a medida que recorre la canalización. Conceptualmente, es un middleware que puede modificar la solicitud antes de que se realice, así como la respuesta cuando se reciba.
PipelineRequest	Metadatos sobre una solicitud realizada por la canalización.
PipelineRequestOptions	Configuración para inicializar una solicitud. Casi equivalente a PipelineRequest< parcial>, pero url es obligatorio.
PipelineResponse	Metadatos sobre una respuesta recibida por la canalización.
PipelineRetryOptions	Opciones que controlan cómo reintentar las solicitudes con errores.
ProxySettings	Opciones para configurar un proxy para las solicitudes salientes (soloNode.js).
PxfObject	Interfaz compatible con el `tls.PxfObject`de NodeJS. Queremos evitar volver a exportar públicamente la interfaz real, ya que puede variar entre versiones en tiempo de ejecución.
RedirectPolicyOptions	Opciones para controlar las respuestas de redirección.
ResourceMethods	Define los métodos a los que se puede llamar en un recurso.
RestErrorOptions	Las opciones admitidas por RestError.
TelemetryOptions	Define las opciones que se usan para configurar información de seguimiento y telemetría comunes.
TlsSettings	Representa un certificado para la autenticación TLS.
UserAgentPolicyOptions	Opciones para agregar detalles del agente de usuario a las solicitudes salientes.

Alias de tipos

AuthScheme	Tipo de unión de todos los esquemas de autenticación admitidos
ClientCredential	Tipo de unión de todas las credenciales de autenticación admitidas.
ClientOptions	Opciones generales que puede tomar un cliente de nivel de rest
EncodingType	Tipo de codificación de caracteres admitido
FormDataMap	Objeto simple que proporciona datos de formulario, como si fuera de un formulario del explorador.
FormDataValue	Cada entrada de datos de formulario puede ser una cadena, un blob o un archivo. Si desea pasar un archivo con un nombre, pero no tiene acceso a la clase File, puede usar el asistente createFile para crear uno.
HttpBrowserStreamResponse	Respuesta HTTP que cuerpo es un objeto de secuencia NodeJS
HttpMethods	Métodos HTTP admitidos que se usarán al realizar solicitudes.
HttpNodeStreamResponse	Respuesta HTTP que cuerpo es un objeto de secuencia NodeJS
HttpResponse	Representa la forma de httpResponse.
OAuth2Flow	Tipo de unión de todos los flujos de OAuth2 admitidos
PathParameters	El tipo auxiliar que se usa para detectar parámetros en un texto de plantilla de ruta de acceso rodeado por {} se considerará un parámetro de ruta de acceso.
PathUnchecked	Define la firma de pathUnchecked.
PathUncheckedResponse	Tipo que se va a usar con pathUnchecked, invalida el tipo de cuerpo en cualquiera para permitir la flexibilidad.
PipelinePhase	Las directivas se ejecutan en fases. El orden de ejecución es: Fase de serialización Directivas que no están en una fase Fase de deserialización Fase de reintento Fase de firma
RawHttpHeaders	Colección HttpHeaders representada como un objeto JSON simple.
RawHttpHeadersInput	Colección HttpHeaders para la entrada, representada como un objeto JSON simple.
RawResponseCallback	Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
RequestBodyType	Tipos de cuerpos admitidos en la solicitud. NodeJS.ReadableStream y () => NodeJS.ReadableStream es solo Node. Blob, ReadableStream<Uint8Array> y () => ReadableStream<Uint8Array> son solo del explorador.
RequestParameters	Forma de los parámetros de solicitud predeterminados, los tipos de solicitud específicos pueden invalidar esto para proporcionar tipos seguros.
SendRequest	Interfaz sencilla para realizar una solicitud de canalización y recibir una respuesta.
StreamableMethod	Define el tipo de un método que admite la obtención del cuerpo de la respuesta como una secuencia sin procesar.
TransferProgressEvent	Se desencadena en respuesta a la carga o descarga del progreso.
TypeSpecRuntimeClientLogger	TypeSpecRuntimeClientLogger es una función que puede registrar en un nivel de gravedad adecuado.
TypeSpecRuntimeLogLevel	Niveles de registro admitidos por el registrador. Los niveles de registro en orden de la mayoría de los detalles a los mínimos detallados son: verboso información advertencia error

Funciones

TypeSpecRuntimeLogger(any[])	Habilita inmediatamente el registro en el nivel de registro especificado. Si no se especifica ningún nivel, el registro está deshabilitado.
createDefaultHttpClient()	Cree el httpClient correcto para el entorno actual.
createEmptyPipeline()	Crea una canalización totalmente vacía. Resulta útil para probar o crear uno personalizado.
createHttpHeaders(RawHttpHeadersInput)	Crea un objeto que satisface la interfaz `HttpHeaders`.
createPipelineRequest(PipelineRequestOptions)	Crea una nueva solicitud de canalización con las opciones especificadas. Este método es permitir la configuración sencilla de los valores predeterminados y no es necesario.
createRestError(PathUncheckedResponse)	Crea un error de resto a partir de una respuesta PathUnchecked
createRestError(string, PathUncheckedResponse)	Crea un error de resto a partir de un mensaje de error y una respuesta PathUnchecked
getClient(string, ClientOptions)	Crea un cliente con una canalización predeterminada.
getLogLevel()	Recupera el nivel de registro especificado actualmente.
isRestError(unknown)	Typeguard para RestError
operationOptionsToRequestParameters(OperationOptions)	Función auxiliar para convertir OperationOptions en RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)	Recupera el nivel de registro especificado actualmente.
stringToUint8Array(string, EncodingType)	El asistente que transforma la cadena en una matriz específica de bytes codificados por caracteres.
uint8ArrayToString(Uint8Array, EncodingType)	Asistente que transforma bytes con codificación de caracteres específica en cadena

Detalles de la función

TypeSpecRuntimeLogger(any[])

Habilita inmediatamente el registro en el nivel de registro especificado. Si no se especifica ningún nivel, el registro está deshabilitado.

function TypeSpecRuntimeLogger(args: any[])

Parámetros

args: any[]

createDefaultHttpClient()

Cree el httpClient correcto para el entorno actual.

function createDefaultHttpClient(): HttpClient

Devoluciones

HttpClient

createEmptyPipeline()

Crea una canalización totalmente vacía. Resulta útil para probar o crear uno personalizado.

function createEmptyPipeline(): Pipeline

Devoluciones

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Crea un objeto que satisface la interfaz HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parámetros

rawHeaders: RawHttpHeadersInput

Objeto simple que representa encabezados iniciales

Devoluciones

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

Crea una nueva solicitud de canalización con las opciones especificadas. Este método es permitir la configuración sencilla de los valores predeterminados y no es necesario.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parámetros

options: PipelineRequestOptions

Opciones para crear la solicitud con.

Devoluciones

PipelineRequest

createRestError(PathUncheckedResponse)

Crea un error de resto a partir de una respuesta PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parámetros

response: PathUncheckedResponse

Devoluciones

RestError

createRestError(string, PathUncheckedResponse)

Crea un error de resto a partir de un mensaje de error y una respuesta PathUnchecked

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

Parámetros

message: string

response: PathUncheckedResponse

Devoluciones

RestError

getClient(string, ClientOptions)

Crea un cliente con una canalización predeterminada.

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

Parámetros

endpoint: string

Punto de conexión base para el cliente

clientOptions: ClientOptions

Devoluciones

Client

getLogLevel()

Recupera el nivel de registro especificado actualmente.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

Devoluciones

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parámetros

e: unknown

Algo capturado por una cláusula catch.

Devoluciones

operationOptionsToRequestParameters(OperationOptions)

Función auxiliar para convertir OperationOptions en RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parámetros

options: OperationOptions

las opciones que usa la capa modular para enviar la solicitud

Devoluciones

RequestParameters

el resultado de la conversión en RequestParameters de la capa de RLC

setLogLevel(TypeSpecRuntimeLogLevel)

Recupera el nivel de registro especificado actualmente.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

Parámetros

logLevel: TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

El asistente que transforma la cadena en una matriz específica de bytes codificados por caracteres.

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

Parámetros

value: string

cadena que se va a convertir

format: EncodingType

el formato que usamos para descodificar el valor

Devoluciones

Uint8Array

Un Uint8Array

uint8ArrayToString(Uint8Array, EncodingType)

Asistente que transforma bytes con codificación de caracteres específica en cadena

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

Parámetros

bytes: Uint8Array

bytes uint8array

format: EncodingType

el formato que usamos para codificar el byte

Devoluciones

string

una cadena de la cadena codificada

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

@typespec/ts-http-runtime package

Clases

Interfaces

Alias de tipos

Funciones

Detalles de la función

TypeSpecRuntimeLogger(any[])

Parámetros

createDefaultHttpClient()

Devoluciones

createEmptyPipeline()

Devoluciones

createHttpHeaders(RawHttpHeadersInput)

Parámetros

Devoluciones

createPipelineRequest(PipelineRequestOptions)

Parámetros

Devoluciones

createRestError(PathUncheckedResponse)

Parámetros

Devoluciones

createRestError(string, PathUncheckedResponse)

Parámetros

Devoluciones

getClient(string, ClientOptions)

Parámetros

Devoluciones

getLogLevel()

Devoluciones

isRestError(unknown)

Parámetros

Devoluciones

operationOptionsToRequestParameters(OperationOptions)

Parámetros

Devoluciones

setLogLevel(TypeSpecRuntimeLogLevel)

Parámetros

stringToUint8Array(string, EncodingType)

Parámetros

Devoluciones

uint8ArrayToString(Uint8Array, EncodingType)

Parámetros

Devoluciones

Comentarios