@typespec/ts-http-runtime package

リファレンス

クラス

このエラーは、非同期操作が中止されたときにスローされます。エラーの name プロパティが 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 基本認証スキームを表します。基本認証スキームでは、リクエストごとにユーザー名とパスワードを指定する必要があります。資格情報は Base64 を使用してエンコードされ、Authorization ヘッダーに含まれます。
BasicCredential	HTTP 基本認証の資格情報。基本認証ヘッダーのユーザー名とパスワードを提供します。
BearerAuthScheme	HTTP Bearer 認証スキームを表します。ベアラー認証スキームでは、各リクエストでベアラートークンを提供する必要があります。トークンは、"Bearer" プレフィックスを持つ Authorization ヘッダーに含まれています。
BearerTokenCredential	Bearer トークン認証の資格情報。
BodyPart	マルチパート要求の要求本文の一部。
Client	Rest Level Client のシェイプ
ClientCredentialsFlow	OAuth2 クライアント資格情報フロー構成を表します。
Debugger
FullOperationResponse	http 要求と応答のラッパーオブジェクト。逆シリアル化されたオブジェクトは、応答本文が JSON で受信されるときに、`parsedBody` プロパティに格納されます。
GetBearerTokenOptions	この操作の get bearer トークン要求を作成して送信するときに使用されるオプション。
GetOAuth2TokenOptions	この操作の get OAuth 2 要求を作成および送信するときに使用されるオプション。
HttpClient	パイプラインに代わって HTTP 要求を行うクライアントに必要なインターフェイス。
HttpHeaders	要求/応答の HTTP ヘッダーのセットを表します。ヘッダー名は、大文字と小文字が区別されないものとして扱われます。
ImplicitFlow	OAuth2 Implicit フロー構成を表します。
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 とほぼ同じですが、URL は必須です。
PipelineResponse	パイプラインによって受信された応答に関するメタデータ。
PipelineRetryOptions	失敗した要求を再試行する方法を制御するオプション。
ProxySettings	送信要求のプロキシを構成するオプション (Node.js のみ)。
PxfObject	NodeJS の `tls.PxfObject`と互換性のあるインターフェイス。実際のインターフェイスはランタイムバージョンによって異なる可能性があるため、パブリックに再エクスポートしないようにする必要があります。
RedirectPolicyOptions	リダイレクト応答の処理方法のオプション。
ResourceMethods	リソースで呼び出すことができるメソッドを定義します
RestErrorOptions	RestError でサポートされるオプション。
TelemetryOptions	一般的なテレメトリとトレース情報の構成に使用されるオプションを定義します
TlsSettings	TLS 認証の証明書を表します。
UserAgentPolicyOptions	送信要求にユーザーエージェントの詳細を追加するためのオプション。

型エイリアス

AuthScheme	サポートされているすべての認証スキームのユニオンの種類
ClientCredential	サポートされているすべての認証資格情報のユニオンの種類。
ClientOptions	Rest Level Client で使用できる一般的なオプション
EncodingType	サポートされている文字エンコードの種類
FormDataMap	ブラウザーフォームの場合と同様に、フォームデータを提供する単純なオブジェクト。
FormDataValue	各フォームデータエントリには、文字列、BLOB、またはファイルを指定できます。名前を持つファイルを渡したいが、File クラスにアクセスできない場合は、createFile ヘルパーを使用して作成できます。
HttpBrowserStreamResponse	NodeJS ストリームオブジェクトである本文の Http 応答
HttpMethods	要求を行うときに使用する HTTP メソッドがサポートされています。
HttpNodeStreamResponse	NodeJS ストリームオブジェクトである本文の Http 応答
HttpResponse	HttpResponse の図形を表します。
OAuth2Flow	サポートされているすべての OAuth2 フローのユニオンの種類
PathParameters	{} で囲まれたパステンプレートテキスト内のパラメーターを検出するために使用されるヘルパー型は、パスパラメーターと見なされます
PathUnchecked	pathUnchecked のシグネチャを定義します。
PathUncheckedResponse	pathUnchecked で使用する型。本文の種類を任意にオーバーライドして柔軟性を確保します
PipelinePhase	ポリシーは段階的に実行されます。実行順序は次のとおりです。シリアル化フェーズフェーズに含まれていないポリシー逆シリアル化フェーズ再試行フェーズ署名フェーズ
RawHttpHeaders	単純な JSON オブジェクトとして表される HttpHeaders コレクション。
RawHttpHeadersInput	単純な JSON オブジェクトとして表される、入力用の HttpHeaders コレクション。
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)	PathUnchecked 応答から rest エラーを作成します
createRestError(string, PathUncheckedResponse)	エラーメッセージと PathUnchecked 応答から rest エラーを作成します。
getClient(string, ClientOptions)	既定のパイプラインを使用してクライアントを作成します
getLogLevel()	現在指定されているログレベルを取得します。
isRestError(unknown)	RestError の Typeguard
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)

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 句によってキャッチされる何か。

戻り値

operationOptionsToRequestParameters(OperationOptions)

OperationOptions を RequestParameters に変換するヘルパー関数

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

パラメーター

options: OperationOptions

Modular レイヤーが要求を送信するために使用するオプション

戻り値

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

エンコードされた文字列の文字列

次の方法で共有

@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)

パラメーター

戻り値