Udostępnij za pośrednictwem

@typespec/ts-http-runtime package

  • Odwołanie

Klasy

AbortError

Ten błąd jest zgłaszany, gdy operacja asynchroniczna została przerwana. Sprawdź ten błąd, testując name, czy właściwość name błędu jest zgodna z "AbortError".

Przykład

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

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Interfejsy

AddPolicyOptions

Opcje podczas dodawania zasad do potoku. Służy do wyrażania zależności od innych zasad.
AdditionalPolicyConfig

Służy do konfigurowania dodatkowych zasad dodanych do potoku w budowie.
Agent

Interfejs zgodny z http.AgentnodeJS. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
ApiKeyAuthScheme

Reprezentuje schemat uwierzytelniania za pomocą klucza interfejsu API. Uwierzytelnianie za pomocą klucza interfejsu API wymaga podania klucza przy każdym żądaniu. Klucz może być podany w różnych lokalizacjach: parametr zapytania, nagłówek lub plik cookie.
ApiKeyCredential

Poświadczenia do uwierzytelniania za pomocą klucza interfejsu API. Udostępnia klucz interfejsu API, który będzie używany w nagłówkach żądań.
AuthorizationCodeFlow

Reprezentuje konfigurację przepływu kodu autoryzacji OAuth2.
BasicAuthScheme

Reprezentuje podstawowy schemat uwierzytelniania HTTP. Podstawowy schemat uwierzytelniania wymaga, aby nazwa użytkownika i hasło były podawane przy każdym żądaniu. Poświadczenia są kodowane przy użyciu Base64 i zawarte w nagłówku Authorization.
BasicCredential

Poświadczenia do uwierzytelniania HTTP Basic. Udostępnia nazwę użytkownika i hasło dla nagłówków uwierzytelniania podstawowego.
BearerAuthScheme

Reprezentuje schemat uwierzytelniania elementu nośnego HTTP. Schemat uwierzytelniania okaziciela wymaga, aby token okaziciela był dostarczany z każdym żądaniem. Token znajduje się w nagłówku Authorization z prefiksem "Bearer".
BearerTokenCredential

Poświadczenia do uwierzytelniania tokenu okaziciela.
BodyPart

Część treści żądania w żądaniu wieloczęściowym.
Client

Kształt klienta na poziomie rest
ClientCredentialsFlow

Reprezentuje konfigurację przepływu poświadczeń klienta OAuth2.
Debugger
FullOperationResponse

Obiekt otoki dla żądania http i odpowiedzi. Deserializowany obiekt jest przechowywany we właściwości parsedBody, gdy treść odpowiedzi zostanie odebrana w formacie JSON.
GetBearerTokenOptions

Opcje używane podczas tworzenia i wysyłania żądań tokenu okaziciela dla tej operacji.
GetOAuth2TokenOptions

Opcje używane podczas tworzenia i wysyłania żądań pobrania OAuth 2 dla tej operacji.
HttpClient

Wymagany interfejs dla klienta, który wysyła żądania HTTP w imieniu potoku.
HttpHeaders

Reprezentuje zestaw nagłówków HTTP dla żądania/odpowiedzi. Nazwy nagłówków są traktowane jako bez uwzględniania wielkości liter.
ImplicitFlow

Reprezentuje konfigurację niejawnego przepływu OAuth2.
KeyObject

Interfejs zgodny z tls.KeyObjectnodeJS. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
LogPolicyOptions

Opcje konfigurowania logPolicy.
MultipartRequestBody

Treść żądania składająca się z wielu części.
NoAuthAuthScheme

Reprezentuje punkt końcowy lub operację, która nie wymaga uwierzytelniania.
OAuth2AuthScheme

Reprezentuje schemat uwierzytelniania OAuth2 z określonymi przepływami
OAuth2TokenCredential

Poświadczenia dla przepływów uwierzytelniania OAuth2.
OperationOptions

Typ opcji podstawowych dla wszystkich operacji.
OperationRequestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
PasswordFlow

Reprezentuje konfigurację przepływu haseł OAuth2.
PathParameterWithOptions

Obiekt, który można przekazać jako parametr ścieżki, co umożliwia ustawienie dodatkowych opcji odnoszących się do sposobu kodowania parametru.
Pipeline

Reprezentuje potok do tworzenia żądania HTTP do adresu URL. Potoki mogą mieć wiele zasad do zarządzania manipulowaniem każdym żądaniem przed i po jego wykonaniu na serwerze.
PipelineOptions

Definiuje opcje używane do konfigurowania potoku HTTP dla klienta zestawu SDK.
PipelinePolicy

Zasady potoku manipulują żądaniem podczas przechodzenia przez potok. Jest to oprogramowanie pośredniczące, które może modyfikować żądanie przed jego wykonaniem, a także odpowiedź po odebraniu.
PipelineRequest

Metadane dotyczące żądania wykonywanego przez potok.
PipelineRequestOptions

Ustawienia inicjowania żądania. Prawie równoważne częściowe, ale adres URL jest obowiązkowy.
PipelineResponse

Metadane dotyczące odpowiedzi odebranej przez potok.
PipelineRetryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
ProxySettings

Opcje konfigurowania serwera proxy dla żądań wychodzących (tylkoNode.js).
PxfObject

Interfejs zgodny z tls.PxfObjectnodeJS. Chcemy uniknąć publicznego ponownego eksportowania rzeczywistego interfejsu, ponieważ może się różnić w różnych wersjach środowiska uruchomieniowego.
RedirectPolicyOptions

Opcje obsługi odpowiedzi przekierowania.
ResourceMethods

Definiuje metody, które można wywołać w zasobie
RestErrorOptions

Opcje obsługiwane przez funkcję RestError.
TelemetryOptions

Definiuje opcje używane do konfigurowania typowych informacji telemetrycznych i śledzenia
TlsSettings

Reprezentuje certyfikat uwierzytelniania TLS.
UserAgentPolicyOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Aliasy typu

AuthScheme

Typ unijny wszystkich obsługiwanych schematów uwierzytelniania
ClientCredential

Typ unii wszystkich obsługiwanych poświadczeń uwierzytelniania.
ClientOptions

Ogólne opcje, które może przyjąć klient poziomu rest
EncodingType

Obsługiwany typ kodowania znaków
FormDataMap

Prosty obiekt, który dostarcza dane formularza, tak jak w przypadku formularza przeglądarki.
FormDataValue

Każdy wpis danych formularza może być ciągiem, obiektem blob lub plikiem. Jeśli chcesz przekazać plik o nazwie, ale nie masz dostępu do klasy File, możesz użyć pomocnika createFile, aby go utworzyć.
HttpBrowserStreamResponse

Odpowiedź HTTP, która treść jest obiektem strumienia NodeJS
HttpMethods

Obsługiwane metody HTTP do użycia podczas wprowadzania żądań.
HttpNodeStreamResponse

Odpowiedź HTTP, która treść jest obiektem strumienia NodeJS
HttpResponse

Reprezentuje kształt obiektu HttpResponse
OAuth2Flow

Typ unii wszystkich obsługiwanych przepływów OAuth2
PathParameters

Typ pomocnika używany do wykrywania parametrów w tekście szablonu ścieżki otoczonym {} będzie traktowany jako parametr ścieżki
PathUnchecked

Definiuje podpis dla pathUnchecked.
PathUncheckedResponse

Typ do użycia z pathUnchecked zastępuje typ treści dowolnym, aby umożliwić elastyczność
PipelinePhase

Zasady są wykonywane w fazach. Kolejność wykonywania to:

  1. Serializowanie fazy
  2. Zasady nie są w fazie
  3. Deserializowanie fazy
  4. Faza ponawiania prób
  5. Faza podpisywania
RawHttpHeaders

Kolekcja HttpHeaders reprezentowana jako prosty obiekt JSON.
RawHttpHeadersInput

Kolekcja HttpHeaders dla danych wejściowych reprezentowana jako prosty obiekt JSON.
RawResponseCallback

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
RequestBodyType

Typy ciał obsługiwanych na żądanie. NodeJS.ReadableStream i () => NodeJS.ReadableStream jest tylko węzłem. Obiekty blob, ReadableStream i () => ReadableStream są tylko przeglądarką.
RequestParameters

Kształt domyślnych parametrów żądania może zostać zastąpiony przez określone typy żądań w celu zapewnienia silnych typów
SendRequest

Prosty interfejs do tworzenia żądania potoku i odbierania odpowiedzi.
StreamableMethod

Definiuje typ metody obsługującej pobieranie treści odpowiedzi jako nieprzetworzonego strumienia
TransferProgressEvent

Wyzwolony w odpowiedzi na postęp przekazywania lub pobierania.
TypeSpecRuntimeClientLogger

TypeSpecRuntimeClientLogger to funkcja, która może rejestrować do odpowiedniego poziomu ważności.
TypeSpecRuntimeLogLevel

Poziomy dziennika obsługiwane przez rejestrator. Poziomy dziennika w kolejności od najbardziej pełnej do najmniejszej pełnej to:

  • rozwlekły
  • Informacja
  • ostrzeżenie
  • błąd

Funkcje

TypeSpecRuntimeLogger(any[])

Natychmiast włącza rejestrowanie na określonym poziomie dziennika. Jeśli nie określono żadnego poziomu, rejestrowanie jest wyłączone.
createDefaultHttpClient()

Utwórz prawidłowy obiekt HttpClient dla bieżącego środowiska.
createEmptyPipeline()

Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.
createHttpHeaders(RawHttpHeadersInput)

Tworzy obiekt, który spełnia interfejs HttpHeaders.
createPipelineRequest(PipelineRequestOptions)

Tworzy nowe żądanie potoku z podanymi opcjami. Ta metoda umożliwia łatwe ustawienie wartości domyślnych i nie jest wymagane.
createRestError(PathUncheckedResponse)

Tworzy błąd rest z odpowiedzi PathUnchecked
createRestError(string, PathUncheckedResponse)

Tworzy błąd rest z komunikatu o błędzie i odpowiedzi PathUnchecked
getClient(string, ClientOptions)

Tworzy klienta z domyślnym potokiem
getLogLevel()

Pobiera aktualnie określony poziom dziennika.
isRestError(unknown)

Funkcja Typeguard dla błędu RestError
operationOptionsToRequestParameters(OperationOptions)

Funkcja pomocnika do konwertowania elementu OperationOptions na RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)

Pobiera aktualnie określony poziom dziennika.
stringToUint8Array(string, EncodingType)

Pomocnik, który przekształca ciąg na określony znak zakodowany w tablicy bajtów.
uint8ArrayToString(Uint8Array, EncodingType)

Pomocnik, który przekształca bajty z określonym kodowaniem znaków na ciąg

Szczegóły funkcji

TypeSpecRuntimeLogger(any[])

Natychmiast włącza rejestrowanie na określonym poziomie dziennika. Jeśli nie określono żadnego poziomu, rejestrowanie jest wyłączone.

function TypeSpecRuntimeLogger(args: any[])

Parametry

args

any[]

createDefaultHttpClient()

Utwórz prawidłowy obiekt HttpClient dla bieżącego środowiska.

function createDefaultHttpClient(): HttpClient

Zwraca

HttpClient

createEmptyPipeline()

Tworzy całkowicie pusty potok. Przydatne do testowania lub tworzenia niestandardowego.

function createEmptyPipeline(): Pipeline

Zwraca

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Tworzy obiekt, który spełnia interfejs HttpHeaders.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parametry

rawHeaders
RawHttpHeadersInput

Prosty obiekt reprezentujący początkowe nagłówki

Zwraca

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

Tworzy nowe żądanie potoku z podanymi opcjami. Ta metoda umożliwia łatwe ustawienie wartości domyślnych i nie jest wymagane.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parametry

options
PipelineRequestOptions

Opcje tworzenia żądania za pomocą polecenia .

Zwraca

PipelineRequest

createRestError(PathUncheckedResponse)

Tworzy błąd rest z odpowiedzi PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parametry

response
PathUncheckedResponse

Zwraca

RestError

createRestError(string, PathUncheckedResponse)

Tworzy błąd rest z komunikatu o błędzie i odpowiedzi PathUnchecked

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

Parametry

message

string

response
PathUncheckedResponse

Zwraca

RestError

getClient(string, ClientOptions)

Tworzy klienta z domyślnym potokiem

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

Parametry

endpoint

string

Podstawowy punkt końcowy klienta

clientOptions
ClientOptions

Zwraca

Client

getLogLevel()

Pobiera aktualnie określony poziom dziennika.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

Zwraca

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

operationOptionsToRequestParameters(OperationOptions)

Funkcja pomocnika do konwertowania elementu OperationOptions na RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parametry

options
OperationOptions

opcje używane przez warstwę modułową do wysyłania żądania

Zwraca

RequestParameters

wynik konwersji w requestParameters warstwy RLC

setLogLevel(TypeSpecRuntimeLogLevel)

Pobiera aktualnie określony poziom dziennika.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

Parametry

logLevel
TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

Pomocnik, który przekształca ciąg na określony znak zakodowany w tablicy bajtów.

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

Parametry

value

string

ciąg, który ma zostać przekonwertowany

format
EncodingType

format używany do dekodowania wartości

Zwraca

Uint8Array

a uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Pomocnik, który przekształca bajty z określonym kodowaniem znaków na ciąg

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

Parametry

bytes

Uint8Array

bajty uint8array

format
EncodingType

format używany do kodowania bajtu

Zwraca

string

ciąg zakodowanego ciągu