@typespec/ts-http-runtime package

Ссылка

Классы

Эта ошибка возникает при прерывании асинхронной операции. Проверьте эту ошибку, проверив name, что свойство имени ошибки соответствует "AbortError".

Пример

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

Настраиваемый тип ошибки для неудачных запросов конвейера.

Интерфейсы

AddPolicyOptions	Параметры при добавлении политики в конвейер. Используется для выражения зависимостей от других политик.
AdditionalPolicyConfig	Используется для настройки дополнительных политик, добавленных в конвейер во время строительства.
Agent	Интерфейс, совместимый с `http.Agent`NodeJS. Мы хотим избежать публичного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
ApiKeyAuthScheme	Представляет схему аутентификации API Key. Для аутентификации по ключу API ключ должен предоставляться с каждым запросом. Ключ может быть предоставлен в разных местах: в параметре запроса, заголовке или cookie.
ApiKeyCredential	Учетные данные для аутентификации по ключу API. Предоставляет ключ API, который будет использоваться в заголовках запросов.
AuthorizationCodeFlow	Представляет конфигурацию потока кода авторизации OAuth2.
BasicAuthScheme	Представляет собой схему проверки подлинности HTTP Basic. Базовая схема аутентификации требует предоставления имени пользователя и пароля при каждом запросе. Учетные данные кодируются с помощью Base64 и включаются в заголовок Authorization.
BasicCredential	Учетные данные для базовой аутентификации HTTP. Предоставляет имя пользователя и пароль для основных заголовков проверки подлинности.
BearerAuthScheme	Представляет схему аутентификации HTTP Bearer. Схема аутентификации носителя требует, чтобы маркер носителя предоставлялся с каждым запросом. Токен включается в заголовок Authorization с префиксом "Bearer".
BearerTokenCredential	Учетные данные для аутентификации токена носителя.
BodyPart	Часть текста запроса в многопартийном запросе.
Client	Форма клиента уровня rest
ClientCredentialsFlow	Представляет конфигурацию потока учетных данных клиента OAuth2.
Debugger
FullOperationResponse	Объект-оболочка для http-запроса и ответа. Десериализированный объект хранится в свойстве `parsedBody` при получении текста ответа в ФОРМАТЕ JSON.
GetBearerTokenOptions	Параметры, используемые при создании и отправке запросов на получение токена носителя для этой операции.
GetOAuth2TokenOptions	Опции, используемые при создании и отправке get OAuth 2 запросов для этой операции.
HttpClient	Обязательный интерфейс для клиента, выполняющего HTTP-запросы от имени конвейера.
HttpHeaders	Представляет набор заголовков HTTP в запросе или ответе. Имена заголовков считаются нечувствительными к регистру.
ImplicitFlow	Представляет конфигурацию неявного потока OAuth2.
KeyObject	Интерфейс, совместимый с `tls.KeyObject`NodeJS. Мы хотим избежать публичного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
LogPolicyOptions	Параметры настройки logPolicy.
MultipartRequestBody	Текст запроса, состоящий из нескольких частей.
NoAuthAuthScheme	Представляет конечную точку или операцию, не требующую проверки подлинности.
OAuth2AuthScheme	Представляет схему проверки подлинности OAuth2 с указанными потоками
OAuth2TokenCredential	Учетные данные для потоков проверки подлинности OAuth2.
OperationOptions	Базовый тип параметров для всех операций.
OperationRequestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
PasswordFlow	Представляет конфигурацию потока паролей OAuth2.
PathParameterWithOptions	Объект, который можно передать в качестве параметра пути, что позволяет задать дополнительные параметры, связанные с кодированием параметра.
Pipeline	Представляет конвейер для создания HTTP-запроса к URL-адресу. Конвейеры могут иметь несколько политик для управления обработкой каждого запроса до и после его выполнения на сервере.
PipelineOptions	Определяет параметры, используемые для настройки конвейера HTTP для клиента ПАКЕТА SDK.
PipelinePolicy	Политика конвейера управляет запросом по мере перемещения по конвейеру. Это концептуально ПО промежуточного слоя, которое разрешено изменять запрос до его создания, а также ответ при получении.
PipelineRequest	Метаданные о запросе, выполняемом конвейером.
PipelineRequestOptions	Параметры для инициализации запроса. Почти эквивалентно частичному, но URL-адрес является обязательным.
PipelineResponse	Метаданные о ответе, полученном конвейером.
PipelineRetryOptions	Параметры, управляющие повторными неудачными запросами.
ProxySettings	Параметры настройки прокси-сервера для исходящих запросов (Node.js только).
PxfObject	Интерфейс, совместимый с `tls.PxfObject`NodeJS. Мы хотим избежать публичного повторного экспорта фактического интерфейса, так как он может отличаться в разных версиях среды выполнения.
RedirectPolicyOptions	Параметры обработки ответов перенаправления.
ResourceMethods	Определяет методы, которые можно вызывать в ресурсе
RestErrorOptions	Параметры, поддерживаемые RestError.
TelemetryOptions	Определяет параметры, используемые для настройки общих данных телеметрии и трассировки
TlsSettings	Представляет сертификат для проверки подлинности TLS.
UserAgentPolicyOptions	Параметры добавления сведений об агенте пользователя в исходящие запросы.

Псевдонимы типа

AuthScheme	Тип объединения всех поддерживаемых схем аутентификации
ClientCredential	Тип объединения всех поддерживаемых учетных данных для проверки подлинности.
ClientOptions	Общие параметры, которые может принимать клиент уровня REST
EncodingType	Поддерживаемый тип кодировки символов
FormDataMap	Простой объект, предоставляющий данные формы, как будто из формы браузера.
FormDataValue	Каждая запись данных формы может быть строкой, BLOB-объектом или файлом. Если вы хотите передать файл с именем, но не имеет доступа к классу File, можно использовать вспомогательный элемент createFile для создания файла.
HttpBrowserStreamResponse	Http Response, текст которого является объектом потока NodeJS
HttpMethods	Поддерживаемые методы HTTP для использования при выполнении запросов.
HttpNodeStreamResponse	Http Response, текст которого является объектом потока NodeJS
HttpResponse	Представляет форму HttpResponse
OAuth2Flow	Тип объединения всех поддерживаемых потоков OAuth2
PathParameters	Вспомогательный тип, используемый для обнаружения параметров в тексте шаблона пути, окруженном {}, будет считаться параметром пути
PathUnchecked	Определяет подпись для pathUnchecked.
PathUncheckedResponse	Тип, используемый с pathUnchecked, переопределяет тип текста на любой, чтобы обеспечить гибкость
PipelinePhase	Политики выполняются на этапах. Порядок выполнения: Этап сериализации Политики не на этапе Этап десериализации Этап повтора Этап подписи
RawHttpHeaders	Коллекция HttpHeaders, представленная как простой объект JSON.
RawHttpHeadersInput	Коллекция HttpHeaders для входных данных, представленная как простой объект JSON.
RawResponseCallback	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
RequestBodyType	Типы тел, поддерживаемые в запросе. NodeJS.ReadableStream и () => NodeJS.ReadableStream — только узел. Blob, ReadableStream и () => ReadableStream — это только браузер.
RequestParameters	Форма параметров запроса по умолчанию, это может быть переопределено определенными типами запросов для предоставления надежных типов.
SendRequest	Простой интерфейс для выполнения запроса конвейера и получения ответа.
StreamableMethod	Определяет тип метода, поддерживающего получение текста ответа в виде необработанного потока.
TransferProgressEvent	Активируется в ответ на ход отправки или скачивания.
TypeSpecRuntimeClientLogger	TypeSpecRuntimeClientLogger — это функция, которая может вести журнал до соответствующего уровня серьезности.
TypeSpecRuntimeLogLevel	Уровни журналов, поддерживаемые средством ведения журнала. Уровни журнала в порядке большинства подробных и подробных: многословный инфо предупреждение ошибка

Функции

TypeSpecRuntimeLogger(any[])	Немедленно включает ведение журнала на указанном уровне ведения журнала. Если уровень не указан, ведение журнала отключается.
createDefaultHttpClient()	Создайте правильный HttpClient для текущей среды.
createEmptyPipeline()	Создает полностью пустой конвейер. Полезно для тестирования или создания пользовательского.
createHttpHeaders(RawHttpHeadersInput)	Создает объект, удовлетворяющий интерфейсу `HttpHeaders`.
createPipelineRequest(PipelineRequestOptions)	Создает новый запрос конвейера с заданными параметрами. Этот метод позволяет легко задавать значения по умолчанию и не требуется.
createRestError(PathUncheckedResponse)	Создает ошибку rest из ответа PathUnchecked
createRestError(string, PathUncheckedResponse)	Создает ошибку rest из сообщения об ошибке и ответа PathUnchecked
getClient(string, ClientOptions)	Создает клиент с конвейером по умолчанию
getLogLevel()	Извлекает текущий указанный уровень журнала.
isRestError(unknown)	Typeguard для RestError
operationOptionsToRequestParameters(OperationOptions)	Вспомогательные функции для преобразования OperationOptions в RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)	Извлекает текущий указанный уровень журнала.
stringToUint8Array(string, EncodingType)	Вспомогательный элемент, который преобразует строку в определенный массив байтов в кодировке символов.
uint8ArrayToString(Uint8Array, EncodingType)	Вспомогательный элемент, который преобразует байты с определенной кодировкой символов в строку

Сведения о функции

TypeSpecRuntimeLogger(any[])

Немедленно включает ведение журнала на указанном уровне ведения журнала. Если уровень не указан, ведение журнала отключается.

function TypeSpecRuntimeLogger(args: any[])

Параметры

args: any[]

createDefaultHttpClient()

Создайте правильный HttpClient для текущей среды.

function createDefaultHttpClient(): HttpClient

Возвращаемое значение

HttpClient

createEmptyPipeline()

Создает полностью пустой конвейер. Полезно для тестирования или создания пользовательского.

function createEmptyPipeline(): Pipeline

Возвращаемое значение

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Создает объект, удовлетворяющий интерфейсу HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Параметры

rawHeaders: RawHttpHeadersInput

Простой объект, представляющий начальные заголовки

Возвращаемое значение

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

Создает новый запрос конвейера с заданными параметрами. Этот метод позволяет легко задавать значения по умолчанию и не требуется.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Параметры

options: PipelineRequestOptions

Параметры для создания запроса.

Возвращаемое значение

PipelineRequest

createRestError(PathUncheckedResponse)

Создает ошибку rest из ответа PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Параметры

response: PathUncheckedResponse

Возвращаемое значение

RestError

createRestError(string, PathUncheckedResponse)

Создает ошибку rest из сообщения об ошибке и ответа PathUnchecked

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

Параметры

message: string

response: PathUncheckedResponse

Возвращаемое значение

RestError

getClient(string, ClientOptions)

Создает клиент с конвейером по умолчанию

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

Параметры

endpoint: string

Базовая конечная точка для клиента

clientOptions: ClientOptions

Возвращаемое значение

Client

getLogLevel()

Извлекает текущий указанный уровень журнала.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

Возвращаемое значение

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Typeguard для RestError

function isRestError(e: unknown): e

Параметры

e: unknown

Что-то поймано предложением catch.

Возвращаемое значение

operationOptionsToRequestParameters(OperationOptions)

Вспомогательные функции для преобразования OperationOptions в RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Параметры

options: OperationOptions

Параметры, используемые модульным слоем для отправки запроса

Возвращаемое значение

RequestParameters

Результат преобразования в RequestParameters слоя RLC

setLogLevel(TypeSpecRuntimeLogLevel)

Извлекает текущий указанный уровень журнала.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

Параметры

logLevel: TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

Вспомогательный элемент, который преобразует строку в определенный массив байтов в кодировке символов.

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

Параметры

value: string

строка, которая будет преобразована

format: EncodingType

формат, используемый для декодирования значения

Возвращаемое значение

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Вспомогательный элемент, который преобразует байты с определенной кодировкой символов в строку

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

Параметры

bytes: Uint8Array

байты uint8array

format: EncodingType

Формат, используемый для кодирования байтов

Возвращаемое значение

string

строка закодированной строки

Поделиться через

@typespec/ts-http-runtime package

Классы

Интерфейсы

Псевдонимы типа

Функции

Сведения о функции

TypeSpecRuntimeLogger(any[])

Параметры

createDefaultHttpClient()

Возвращаемое значение

createEmptyPipeline()

Возвращаемое значение

createHttpHeaders(RawHttpHeadersInput)

Параметры

Возвращаемое значение

createPipelineRequest(PipelineRequestOptions)

Параметры

Возвращаемое значение

createRestError(PathUncheckedResponse)

Параметры

Возвращаемое значение

createRestError(string, PathUncheckedResponse)

Параметры

Возвращаемое значение

getClient(string, ClientOptions)

Параметры

Возвращаемое значение

getLogLevel()

Возвращаемое значение

isRestError(unknown)

Параметры

Возвращаемое значение

operationOptionsToRequestParameters(OperationOptions)

Параметры

Возвращаемое значение

setLogLevel(TypeSpecRuntimeLogLevel)

Параметры

stringToUint8Array(string, EncodingType)

Параметры

Возвращаемое значение

uint8ArrayToString(Uint8Array, EncodingType)

Параметры

Возвращаемое значение