@typespec/ts-http-runtime package

Referentie

Klassen

Deze fout wordt gegenereerd wanneer een asynchrone bewerking is afgebroken. Controleer op deze fout door de name te testen of de naameigenschap van de fout overeenkomt met "AbortError".

Voorbeeld

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

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Interfaces

AddPolicyOptions	Opties bij het toevoegen van een beleid aan de pijplijn. Wordt gebruikt om afhankelijkheden van ander beleid uit te drukken.
AdditionalPolicyConfig	Wordt gebruikt voor het configureren van extra beleidsregels die zijn toegevoegd aan de pijplijn tijdens de bouw.
Agent	Een interface die compatibel is met de `http.Agent`van NodeJS. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren in runtimeversies.
ApiKeyAuthScheme	Vertegenwoordigt API-sleutelverificatieschema. API-sleutelverificatie vereist dat bij elke aanvraag een sleutel wordt verstrekt. De sleutel kan op verschillende locaties worden opgegeven: queryparameter, header of cookie.
ApiKeyCredential	Referentie voor API-sleutelverificatie. Biedt een API-sleutel die wordt gebruikt in de aanvraagheaders.
AuthorizationCodeFlow	Vertegenwoordigt de configuratie van de OAuth2-autorisatiecodestroom.
BasicAuthScheme	Vertegenwoordigt HTTP Basic-verificatieschema. Het basisauthenticatieschema vereist dat bij elk verzoek een gebruikersnaam en wachtwoord worden opgegeven. De referenties worden gecodeerd met behulp van Base64 en opgenomen in de autorisatieheader.
BasicCredential	Referentie voor HTTP Basic-verificatie. Biedt gebruikersnaam en wachtwoord voor basisverificatieheaders.
BearerAuthScheme	Vertegenwoordigt het HTTP Bearer-verificatieschema. Het authenticatieschema aan toonder vereist dat bij elk verzoek een token aan toonder wordt verstrekt. Het token wordt opgenomen in de autorisatieheader met het voorvoegsel 'Bearer'.
BearerTokenCredential	Referentie voor verificatie van toondertokens.
BodyPart	Een deel van de aanvraagbody in een aanvraag met meerdere onderdelen.
Client	Vorm van een client op restniveau
ClientCredentialsFlow	Vertegenwoordigt de configuratie van de OAuth2-clientreferentiesstroom.
Debugger
FullOperationResponse	Wrapper-object voor http-aanvraag en -antwoord. Het gedeserialiseerde object wordt opgeslagen in de eigenschap `parsedBody` wanneer de hoofdtekst van het antwoord wordt ontvangen in JSON.
GetBearerTokenOptions	Opties die worden gebruikt bij het maken en verzenden van aanvragen voor toondertokens voor deze bewerking.
GetOAuth2TokenOptions	Opties die worden gebruikt bij het maken en verzenden van OAuth 2-aanvragen voor deze bewerking.
HttpClient	De vereiste interface voor een client die HTTP-aanvragen namens een pijplijn doet.
HttpHeaders	Vertegenwoordigt een set HTTP-headers voor een aanvraag/antwoord. Headernamen worden behandeld als niet hoofdlettergevoelig.
ImplicitFlow	Vertegenwoordigt OAuth2 Impliciete stroomconfiguratie.
KeyObject	Een interface die compatibel is met de `tls.KeyObject`van NodeJS. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren in runtimeversies.
LogPolicyOptions	Opties voor het configureren van logPolicy.
MultipartRequestBody	Een aanvraagbody die bestaat uit meerdere onderdelen.
NoAuthAuthScheme	Vertegenwoordigt een eindpunt of bewerking waarvoor geen verificatie is vereist.
OAuth2AuthScheme	Vertegenwoordigt OAuth2-verificatieschema met gespecificeerde stromen
OAuth2TokenCredential	Referentie voor OAuth2-verificatiestromen.
OperationOptions	Het type basisopties voor alle bewerkingen.
OperationRequestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
PasswordFlow	Vertegenwoordigt de configuratie van de OAuth2-wachtwoordstroom.
PathParameterWithOptions	Een object dat kan worden doorgegeven als padparameter, zodat extra opties kunnen worden ingesteld met betrekking tot hoe de parameter wordt gecodeerd.
Pipeline	Vertegenwoordigt een pijplijn voor het maken van een HTTP-aanvraag naar een URL. Pijplijnen kunnen meerdere beleidsregels hebben voor het beheren van het bewerken van elke aanvraag voor en nadat deze op de server is aangebracht.
PipelineOptions	Definieert opties die worden gebruikt voor het configureren van de HTTP-pijplijn voor een SDK-client.
PipelinePolicy	Een pijplijnbeleid bewerkt een aanvraag tijdens het doorlopen van de pijplijn. Het is conceptueel een middleware die de aanvraag mag wijzigen voordat deze wordt gedaan, evenals het antwoord wanneer deze wordt ontvangen.
PipelineRequest	Metagegevens over een aanvraag die door de pijplijn wordt ingediend.
PipelineRequestOptions	Instellingen voor het initialiseren van een aanvraag. Bijna gelijk aan Gedeeltelijk, maar de URL is verplicht.
PipelineResponse	Metagegevens over een antwoord dat door de pijplijn is ontvangen.
PipelineRetryOptions	Opties voor het opnieuw proberen van mislukte aanvragen.
ProxySettings	Opties voor het configureren van een proxy voor uitgaande aanvragen (alleenNode.js).
PxfObject	Een interface die compatibel is met de `tls.PxfObject`van NodeJS. We willen voorkomen dat de werkelijke interface openbaar opnieuw wordt geëxporteerd, omdat deze kan variëren in runtimeversies.
RedirectPolicyOptions	Opties voor de manier waarop omleidingsreacties worden verwerkt.
ResourceMethods	Definieert de methoden die kunnen worden aangeroepen voor een resource
RestErrorOptions	De opties die worden ondersteund door RestError.
TelemetryOptions	Definieert opties die worden gebruikt voor het configureren van algemene telemetrie- en traceringsgegevens
TlsSettings	Vertegenwoordigt een certificaat voor TLS-verificatie.
UserAgentPolicyOptions	Opties voor het toevoegen van gebruikersagentgegevens aan uitgaande aanvragen.

Type-aliassen

AuthScheme	Unietype van alle ondersteunde authenticatieschema's
ClientCredential	Unietype van alle ondersteunde verificatiereferenties.
ClientOptions	Algemene opties die een client op restniveau kan nemen
EncodingType	Het ondersteunde tekencoderingstype
FormDataMap	Een eenvoudig object dat formuliergegevens levert, alsof dit afkomstig is van een browserformulier.
FormDataValue	Elke formuliergegevensinvoer kan een tekenreeks, blob of een bestand zijn. Als u een bestand met een naam wilt doorgeven, maar geen toegang hebt tot de bestandsklasse, kunt u de createFile-helper gebruiken om er een te maken.
HttpBrowserStreamResponse	Http Response: hoofdtekst van een NodeJS-streamobject
HttpMethods	Ondersteunde HTTP-methoden voor gebruik bij het indienen van aanvragen.
HttpNodeStreamResponse	Http Response: hoofdtekst van een NodeJS-streamobject
HttpResponse	Vertegenwoordigt de vorm van een HttpResponse
OAuth2Flow	Unietype van alle ondersteunde OAuth2-stromen
PathParameters	Helpertype dat wordt gebruikt voor het detecteren van parameters in een padsjabloontekst die wordt omgeven door {} wordt beschouwd als een padparameter
PathUnchecked	Hiermee definieert u de handtekening voor pathUnchecked.
PathUncheckedResponse	Type dat moet worden gebruikt met pathUnchecked, overschrijft het type hoofdtekst om flexibiliteit mogelijk te maken
PipelinePhase	Beleidsregels worden in fasen uitgevoerd. De uitvoeringsvolgorde is: Fase serialiseren Beleid niet in een fase Fase deserialiseren Fase opnieuw proberen Tekenfase
RawHttpHeaders	Een HttpHeaders-verzameling die wordt weergegeven als een eenvoudig JSON-object.
RawHttpHeadersInput	Een HttpHeaders-verzameling voor invoer, weergegeven als een eenvoudig JSON-object.
RawResponseCallback	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
RequestBodyType	Typen lichamen die op de aanvraag worden ondersteund. NodeJS.ReadableStream en () => NodeJS.ReadableStream is alleen knooppunt. Blob, ReadableStream en () => ReadableStream zijn alleen browser.
RequestParameters	Vorm van de standaardaanvraagparameters, dit kan worden overschreven door de specifieke aanvraagtypen om sterke typen te bieden
SendRequest	Een eenvoudige interface voor het maken van een pijplijnaanvraag en het ontvangen van een antwoord.
StreamableMethod	Definieert het type voor een methode die ondersteuning biedt voor het verkrijgen van de hoofdtekst van het antwoord als een onbewerkte stroom
TransferProgressEvent	Geactiveerd als reactie op het uploaden of downloaden van de voortgang.
TypeSpecRuntimeClientLogger	Een TypeSpecRuntimeClientLogger is een functie die kan worden geregistreerd op een geschikt ernstniveau.
TypeSpecRuntimeLogLevel	De logboekniveaus die worden ondersteund door de logboekregistratie. De logboekniveaus in volgorde van de meeste uitgebreide tot minst uitgebreide zijn: langdradig informatie waarschuwing fout

Functies

TypeSpecRuntimeLogger(any[])	Hiermee schakelt u logboekregistratie onmiddellijk in op het opgegeven logboekniveau. Als er geen niveau is opgegeven, wordt logboekregistratie uitgeschakeld.
createDefaultHttpClient()	Maak de juiste HttpClient voor de huidige omgeving.
createEmptyPipeline()	Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste.
createHttpHeaders(RawHttpHeadersInput)	Hiermee maakt u een object dat voldoet aan de `HttpHeaders`-interface.
createPipelineRequest(PipelineRequestOptions)	Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is bedoeld om de eenvoudige instelling van standaardwaarden toe te staan en niet vereist.
createRestError(PathUncheckedResponse)	Hiermee maakt u een rustfout op basis van een PathUnchecked-antwoord
createRestError(string, PathUncheckedResponse)	Hiermee maakt u een rustfout op basis van een foutbericht en een PathUnchecked-antwoord
getClient(string, ClientOptions)	Hiermee maakt u een client met een standaardpijplijn
getLogLevel()	Hiermee wordt het momenteel opgegeven logboekniveau opgehaald.
isRestError(unknown)	Typeguard voor RestError
operationOptionsToRequestParameters(OperationOptions)	De Helper-functie voor het converteren van OperationOptions naar RequestParameters
setLogLevel(TypeSpecRuntimeLogLevel)	Hiermee wordt het momenteel opgegeven logboekniveau opgehaald.
stringToUint8Array(string, EncodingType)	De helper waarmee de tekenreeks wordt getransformeerd naar een specifieke tekencodeerde bytesmatrix.
uint8ArrayToString(Uint8Array, EncodingType)	De helper waarmee bytes met specifieke tekencodering worden getransformeerd in een tekenreeks

Functiedetails

TypeSpecRuntimeLogger(any[])

Hiermee schakelt u logboekregistratie onmiddellijk in op het opgegeven logboekniveau. Als er geen niveau is opgegeven, wordt logboekregistratie uitgeschakeld.

function TypeSpecRuntimeLogger(args: any[])

Parameters

args: any[]

createDefaultHttpClient()

Maak de juiste HttpClient voor de huidige omgeving.

function createDefaultHttpClient(): HttpClient

Retouren

HttpClient

createEmptyPipeline()

Hiermee maakt u een volledig lege pijplijn. Handig voor het testen of maken van een aangepaste.

function createEmptyPipeline(): Pipeline

Retouren

Pipeline

createHttpHeaders(RawHttpHeadersInput)

Hiermee maakt u een object dat voldoet aan de HttpHeaders-interface.

function createHttpHeaders(rawHeaders?: RawHttpHeadersInput): HttpHeaders

Parameters

rawHeaders: RawHttpHeadersInput

Een eenvoudig object dat de eerste headers vertegenwoordigt

Retouren

HttpHeaders

createPipelineRequest(PipelineRequestOptions)

Hiermee maakt u een nieuwe pijplijnaanvraag met de opgegeven opties. Deze methode is bedoeld om de eenvoudige instelling van standaardwaarden toe te staan en niet vereist.

function createPipelineRequest(options: PipelineRequestOptions): PipelineRequest

Parameters

options: PipelineRequestOptions

De opties voor het maken van de aanvraag.

Retouren

PipelineRequest

createRestError(PathUncheckedResponse)

Hiermee maakt u een rustfout op basis van een PathUnchecked-antwoord

function createRestError(response: PathUncheckedResponse): RestError

Parameters

response: PathUncheckedResponse

Retouren

RestError

createRestError(string, PathUncheckedResponse)

Hiermee maakt u een rustfout op basis van een foutbericht en een PathUnchecked-antwoord

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

Parameters

message: string

response: PathUncheckedResponse

Retouren

RestError

getClient(string, ClientOptions)

Hiermee maakt u een client met een standaardpijplijn

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

Parameters

endpoint: string

Basiseindpunt voor de client

clientOptions: ClientOptions

Retouren

Client

getLogLevel()

Hiermee wordt het momenteel opgegeven logboekniveau opgehaald.

function getLogLevel(): TypeSpecRuntimeLogLevel | undefined

Retouren

TypeSpecRuntimeLogLevel | undefined

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Iets betrapt door een catch-component.

Retouren

operationOptionsToRequestParameters(OperationOptions)

De Helper-functie voor het converteren van OperationOptions naar RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parameters

options: OperationOptions

de opties die door de modulaire laag worden gebruikt om de aanvraag te verzenden

Retouren

RequestParameters

het resultaat van de conversie in RequestParameters van RLC-laag

setLogLevel(TypeSpecRuntimeLogLevel)

Hiermee wordt het momenteel opgegeven logboekniveau opgehaald.

function setLogLevel(logLevel?: TypeSpecRuntimeLogLevel)

Parameters

logLevel: TypeSpecRuntimeLogLevel

stringToUint8Array(string, EncodingType)

De helper waarmee de tekenreeks wordt getransformeerd naar een specifieke tekencodeerde bytesmatrix.

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

Parameters

value: string

de tekenreeks die moet worden geconverteerd

format: EncodingType

de indeling die we gebruiken om de waarde te decoderen

Retouren

Uint8Array

een uint8array

uint8ArrayToString(Uint8Array, EncodingType)

De helper waarmee bytes met specifieke tekencodering worden getransformeerd in een tekenreeks

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

Parameters

bytes: Uint8Array

de uint8array-bytes

format: EncodingType

de indeling die we gebruiken om de byte te coderen

Retouren

string

een tekenreeks van de gecodeerde tekenreeks

Delen via

@typespec/ts-http-runtime package

Klassen

Interfaces

Type-aliassen

Functies

Functiedetails

TypeSpecRuntimeLogger(any[])

Parameters

createDefaultHttpClient()

Retouren

createEmptyPipeline()

Retouren

createHttpHeaders(RawHttpHeadersInput)

Parameters

Retouren

createPipelineRequest(PipelineRequestOptions)

Parameters

Retouren

createRestError(PathUncheckedResponse)

Parameters

Retouren

createRestError(string, PathUncheckedResponse)

Parameters

Retouren

getClient(string, ClientOptions)

Parameters

Retouren

getLogLevel()

Retouren

isRestError(unknown)

Parameters

Retouren

operationOptionsToRequestParameters(OperationOptions)

Parameters

Retouren

setLogLevel(TypeSpecRuntimeLogLevel)

Parameters

stringToUint8Array(string, EncodingType)

Parameters

Retouren

uint8ArrayToString(Uint8Array, EncodingType)

Parameters

Retouren

Feedback