通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@typespec/ts-http-runtime package

类

AbortError

异步作已中止时，将引发此错误。 通过测试错误的名称属性是否与 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

与 NodeJS 的 http.Agent兼容的接口。 我们希望避免公开重新导出实际接口，因为它可能因运行时版本而异。
ApiKeyAuthScheme

表示 API 密钥身份验证方案。 API 密钥身份验证要求为每个请求提供密钥。 密钥可以在不同的位置提供：查询参数、标头或 Cookie。
ApiKeyCredential

用于 API 密钥身份验证的凭据。 提供将在请求标头中使用的 API 密钥。
AuthorizationCodeFlow

表示 OAuth2 授权代码流配置。
BasicAuthScheme

表示 HTTP Basic 身份验证方案。 基本身份验证方案要求为每个请求提供用户名和密码。 凭证使用 Base64 编码，并包含在 Authorization 标头中。
BasicCredential

用于 HTTP 基本身份验证的凭据。 提供基本身份验证标头的用户名和密码。
BearerAuthScheme

表示 HTTP Bearer 身份验证方案。 不记名身份验证方案要求为每个请求提供不记名令牌。 令牌包含在 Authorization 标头中，带有 “Bearer” 前缀。
BearerTokenCredential

用于 Bearer 令牌身份验证的凭据。
BodyPart

多部分请求中的请求正文的一部分。
Client

Rest 级别客户端的形状
ClientCredentialsFlow

表示 OAuth2 客户端凭据流配置。
Debugger
FullOperationResponse

http 请求和响应的包装器对象。 当响应正文以 JSON 接收时，反序列化对象存储在 parsedBody 属性中。
GetBearerTokenOptions

为此作创建和发送 get bearer token 请求时使用的选项。
GetOAuth2TokenOptions

创建和发送此作的 get OAuth 2 请求时使用的选项。
HttpClient

代表管道发出 HTTP 请求的客户端所需的接口。
HttpHeaders

表示请求/响应上的一组 HTTP 标头。 标头名称被视为不区分大小写。
ImplicitFlow

表示 OAuth2 隐式流配置。
KeyObject

与 NodeJS 的 tls.KeyObject兼容的接口。 我们希望避免公开重新导出实际接口，因为它可能因运行时版本而异。
LogPolicyOptions

用于配置 logPolicy 的选项。
MultipartRequestBody

包含多个部分的请求正文。
NoAuthAuthScheme

表示不需要身份验证的终端节点或作。
OAuth2AuthScheme

表示具有指定流的 OAuth2 身份验证方案
OAuth2TokenCredential

OAuth2 身份验证流的凭据。
OperationOptions

所有操作的基本选项类型。
OperationRequestOptions

为此操作创建和发送 HTTP 请求时使用的选项。
PasswordFlow

表示 OAuth2 密码流配置。
PathParameterWithOptions

可以作为路径参数传递的对象，允许设置与参数编码方式相关的其他选项。
Pipeline

表示向 URL 发出 HTTP 请求的管道。 管道可以有多个策略来管理对服务器之前和之后每个请求的作。
PipelineOptions

定义用于为 SDK 客户端配置 HTTP 管道的选项。
PipelinePolicy

管道策略在流经管道时作请求。 从概念上讲，它是一个中间件，允许在收到请求之前修改请求以及响应。
PipelineRequest

有关管道发出的请求的元数据。
PipelineRequestOptions

用于初始化请求的设置。 几乎等同于 Partial<PipelineRequest>，但 url 是必填的。
PipelineResponse

有关管道收到的响应的元数据。
PipelineRetryOptions

控制如何重试失败请求的选项。
ProxySettings

为传出请求配置代理的选项（仅Node.js）。
PxfObject

与 NodeJS 的 tls.PxfObject兼容的接口。 我们希望避免公开重新导出实际接口，因为它可能因运行时版本而异。
RedirectPolicyOptions

有关如何处理重定向响应的选项。
ResourceMethods

定义可在资源上调用的方法
RestErrorOptions

RestError 支持的选项。
TelemetryOptions

定义用于配置常见遥测和跟踪信息的选项
TlsSettings

表示 TLS 身份验证的证书。
UserAgentPolicyOptions

用于将用户代理详细信息添加到传出请求的选项。

类型别名

AuthScheme

所有支持的身份验证方案的联合类型
ClientCredential

Union 类型。
ClientOptions

Rest Level 客户端可以采用的常规选项
EncodingType

支持的字符编码类型
FormDataMap

提供表单数据的简单对象，就像从浏览器窗体中一样。
FormDataValue

每个表单数据条目可以是字符串、Blob 或文件。 如果要传递具有名称但无权访问 File 类的文件，可以使用 createFile 帮助程序创建一个文件。
HttpBrowserStreamResponse

Http 响应，正文是 NodeJS 流对象
HttpMethods

支持在发出请求时使用的 HTTP 方法。
HttpNodeStreamResponse

Http 响应，正文是 NodeJS 流对象
HttpResponse

表示 HttpResponse 的形状
OAuth2Flow

所有受支持的 OAuth2 流的联合类型
PathParameters

用于检测 {} 包围的路径模板文本中的参数的帮助程序类型将被视为路径参数
PathUnchecked

定义 pathUnchecked 的签名。
PathUncheckedResponse

要与 pathUnchecked 一起使用的类型，将正文类型重写为任意类型以允许灵活性
PipelinePhase

策略分阶段执行。 执行顺序为：

  1. 序列化阶段
  2. 策略不在阶段
  3. 反序列化阶段
  4. 重试阶段
  5. 签名阶段
RawHttpHeaders

表示为简单 JSON 对象的 HttpHeaders 集合。
RawHttpHeadersInput

用于输入的 HttpHeaders 集合，表示为简单的 JSON 对象。
RawResponseCallback

在执行请求的操作时，每次从服务器接收响应时调用的函数。 可以多次调用。
RequestBodyType

请求支持的类型。 NodeJS.ReadableStream 和 （） => NodeJS.ReadableStream 仅是 Node。 Blob、ReadableStream<Uint8Array> 和 （） => ReadableStream<Uint8Array> 仅限浏览器。
RequestParameters

默认请求参数的形状，这可能会被特定请求类型重写以提供强类型
SendRequest

用于发出管道请求和接收响应的简单接口。
StreamableMethod

定义支持将响应正文作为原始流获取的方法的类型
TransferProgressEvent

响应上传或下载进度而触发。
TypeSpecRuntimeClientLogger

TypeSpecRuntimeClientLogger 是一个可以记录到适当严重性级别的函数。
TypeSpecRuntimeLogLevel

记录器支持的日志级别。 日志级别按最详细到最不详细的顺序为：

  • 详细的
  • 信息
  • 警告
  • 错误

函数

TypeSpecRuntimeLogger(any[])

立即在指定的日志级别启用日志记录。 如果未指定级别，则禁用日志记录。
createDefaultHttpClient()

为当前环境创建正确的 HttpClient。
createEmptyPipeline()

创建完全空的管道。 可用于测试或创建自定义模板。
createHttpHeaders(RawHttpHeadersInput)

创建满足 HttpHeaders 接口的对象。
createPipelineRequest(PipelineRequestOptions)

使用给定选项创建新的管道请求。 此方法允许轻松设置默认值，而不需要设置默认值。
createRestError(PathUncheckedResponse)

从 PathUnchecked 响应创建 rest 错误
createRestError(string, PathUncheckedResponse)

从错误消息和 PathUnchecked 响应创建 rest 错误
getClient(string, ClientOptions)

使用默认管道创建客户端
getLogLevel()

检索当前指定的日志级别。
isRestError(unknown)

RestError 的 Typeguard
operationOptionsToRequestParameters(OperationOptions)

用于将 OperationOptions 转换为 RequestParameters 的 Helper 函数
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)

从 PathUnchecked 响应创建 rest 错误

function createRestError(response: PathUncheckedResponse): RestError

参数

response
PathUncheckedResponse

返回

RestError

createRestError(string, PathUncheckedResponse)

从错误消息和 PathUnchecked 响应创建 rest 错误

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)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

operationOptionsToRequestParameters(OperationOptions)

用于将 OperationOptions 转换为 RequestParameters 的 Helper 函数

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

参数

options
OperationOptions

模块化层用于发送请求的选项

返回

RequestParameters

RLC 层 RequestParameters 中的转换结果

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

编码字符串的字符串