@typespec/ts-http-runtime package

클래스

이 오류는 비동기 작업이 중단된 경우 throw됩니다. 오류의 이름 속성이 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 키 인증을 위해서는 각 요청과 함께 키를 제공해야 합니다. 키는 쿼리 매개 변수, 헤더 또는 쿠키와 같은 다양한 위치에 제공될 수 있습니다.
ApiKeyCredential	API 키 인증을 위한 자격 증명입니다. 요청 헤더에 사용할 API 키를 제공합니다.
AuthorizationCodeFlow	OAuth2 인증 코드 흐름 구성을 나타냅니다.
BasicAuthScheme	HTTP 기본 인증 체계를 나타냅니다. 기본 인증 체계를 사용하려면 각 요청과 함께 사용자 이름과 암호를 제공해야 합니다. 자격 증명은 Base64를 사용하여 인코딩되고 권한 부여 헤더에 포함됩니다.
BasicCredential	HTTP 기본 인증을 위한 자격 증명입니다. 기본 인증 헤더에 대한 사용자 이름과 암호를 제공합니다.
BearerAuthScheme	HTTP 전달자 인증 체계를 나타냅니다. 전달자 인증 체계를 사용하려면 각 요청과 함께 전달자 토큰을 제공해야 합니다. 토큰은 "Bearer" 접두사와 함께 Authorization 헤더에 포함됩니다.
BearerTokenCredential	전달자 토큰 인증을 위한 자격 증명입니다.
BodyPart	다중 파트 요청의 요청 본문 부분입니다.
Client	Rest Level 클라이언트의 셰이프
ClientCredentialsFlow	OAuth2 클라이언트 자격 증명 흐름 구성을 나타냅니다.
Debugger
FullOperationResponse	http 요청 및 응답에 대한 래퍼 개체입니다. 역직렬화된 개체는 JSON에서 응답 본문을 받을 때 `parsedBody` 속성에 저장됩니다.
GetBearerTokenOptions	이 작업에 대한 전달자 토큰 가져오기 요청을 만들고 보낼 때 사용되는 옵션입니다.
GetOAuth2TokenOptions	이 작업에 대한 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	지원되는 모든 인증 자격 증명의 공용 구조체 유형입니다.
ClientOptions	Rest Level 클라이언트에서 사용할 수 있는 일반 옵션
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<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 응답에서 나머지 오류를 만듭니다.
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 응답에서 나머지 오류를 만듭니다.

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

캐치 절에 의해 잡힌 무언가.

반환

operationOptionsToRequestParameters(OperationOptions)

OperationOptions를 RequestParameters로 변환하는 도우미 함수

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

인코딩된 문자열의 문자열

피드백

이 페이지가 도움이 되었나요?

다음을 통해 공유

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

매개 변수

반환

피드백