@azure/core-amqp package

Klasser

CbsClient	Beskriver EventHub/ServiceBus Cbs-klienten som pratar med $cbs slutpunkten över AMQP-anslutningen.
MessagingError	Beskriver basklassen för meddelandefel.
RequestResponseLink	Beskriver en amqp request(sender)-response(receiver)-länk som skapas över en amqp-session.

Gränssnitt

AcquireLockProperties	Beskriver de egenskaper som måste anges när du hämtar ett lås.
AmqpAnnotatedMessage	Beskriver AmqpAnnotatedMessage, en del av ServiceBusReceivedMessage(som amqpAnnotatedMessage-egenskapen).
AmqpMessageHeader	Beskriver den definierade uppsättningen standardhuvudegenskaper för meddelandet.
AmqpMessageProperties	Beskriver den definierade uppsättningen standardegenskaper för meddelandet.
CancellableAsyncLock	CancellableAsyncLock tillhandahåller en mekanism för att tvinga uppgifter med samma nyckel att köras seriellt. Väntande aktiviteter kan avbrytas manuellt via en abortSignal eller automatiskt avbrytas genom att nå ett angivet timeout-värde.
CbsResponse	Beskriver CBS-svaret.
ConnectionConfig	Beskriver anslutningskonfigurationsobjektet som skapas efter parsning av en EventHub- eller ServiceBus-anslutningssträng.
ConnectionConfigOptions	Beskriver de alternativ som kan anges när du skapar en anslutningskonfiguration.
ConnectionContextBase	Ger sammanhangsberoende information som den underliggande amqp-anslutningen, cbs-sessionen, tokenProvider, anslutningskonfiguration, datatransformator osv.
ConnectionProperties	Definierar de egenskaper som måste anges när AMQP-anslutningen upprättas.
CreateConnectionContextBaseParameters	Beskriver de parametrar som kan anges för att skapa basanslutningskontexten.
NetworkSystemError	Beskriver fälten på en Node.js SystemError. Utelämnar fält som inte är relaterade till nätverksanrop (t.ex. filsystemanrop). Se https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Beskriver de parametrar som måste konfigureras för återförsöksåtgärden.
RetryOptions	Återförsök av principalternativ som avgör läget, antalet återförsök, återförsöksintervall osv.
SendRequestOptions	Beskriver de alternativ som kan anges när en begäran skickas.
WebSocketOptions	Alternativ för att konfigurera kanalisering av AMQP-anslutningen via Web Sockets.

Typalias

ParsedOutput

Definierar ett objekt med möjliga egenskaper som definierats i T.

Uppräkningar

ConditionErrorNameMapper	Mappar amqp-felvillkoren till felnamnen.
ErrorNameConditionMapper	Mappar felnamnen till amqp-felvillkoren.
RetryMode	Beskriver typ av återförsöksläge
RetryOperationType	Beskriver typen av återförsöksåtgärd.
SystemErrorConditionMapper	Mappar vissa SystemErrors till amqp-felvillkor
TokenType	Beskriver typen av token som stöds.

Funktioner

delay<T>(number, AbortSignalLike, string, T)	En wrapper för setTimeout som löser ett löfte efter t millisekunder.
isMessagingError(MessagingError | Error)	Avgör om ett fel är en MessagingError.
isSystemError(unknown)	Kontrollerar om det angivna felet är en node.js SystemError.
parseConnectionString<T>(string)	Parsar anslutningssträngen och returnerar ett objekt av typen T. Anslutningssträngar har följande syntax: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Del ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? alla teckensekvenser utom ; eller = eller Blanksteg? Tomt utrymme ::= ? alla blankstegstecken, inklusive \r och \n?
retry<T>(RetryConfig<T>)	Varje åtgärd görs minst en gång. Ytterligare försök görs om föregående försök misslyckades med ett återförsöksfel. Antalet ytterligare försök styrs av egenskapen maxRetries som anges i argumentet RetryConfig. Om mode alternativet är inställt på Fixedgörs återförsöken för den angivna åtgärden under ett angivet antal gånger, med en fast fördröjning mellan varje nytt försök varje gång. Om mode alternativet är inställt på Exponentialjusteras fördröjningen mellan återförsöken för att öka exponentiellt med varje försök att använda back-off-faktor för effekt 2.
translate(unknown)	Översätter AMQP-felet som tas emot på protokollskiktet eller en SystemError till en MessagingError. Alla andra fel returneras oförändrade.

Funktionsinformation

delay<T>(number, AbortSignalLike, string, T)

En wrapper för setTimeout som löser ett löfte efter t millisekunder.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Parametrar

delayInMs

number

Antalet millisekunder som ska fördröjas.

abortSignal

AbortSignalLike

AbortSignal som är associerad med innehållande åtgärd.

abortErrorMsg

string

Det avbrutna felmeddelandet som är associerat med en åtgärd som innehåller åtgärden.

value

T

Värdet som ska matchas med efter en timeout på t millisekunder.

Returer

Promise<T | void>

• Löst löfte

isMessagingError(MessagingError | Error)

Avgör om ett fel är en MessagingError.

function isMessagingError(error: MessagingError | Error): error

Parametrar

error

MessagingError | Error

Ett fel som antingen kan vara ett fel eller en MessagingError.

Returer

error

isSystemError(unknown)

Kontrollerar om det angivna felet är en node.js SystemError.

function isSystemError(err: unknown): err

Parametrar

err

unknown

Ett objekt som kan innehålla felinformation.

Returer

err

parseConnectionString<T>(string)

Parsar anslutningssträngen och returnerar ett objekt av typen T.

Anslutningssträngar har följande syntax:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Del ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? alla teckensekvenser utom ; eller = eller Blanksteg? Tomt utrymme ::= ? alla blankstegstecken, inklusive \r och \n?

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

Parametrar

connectionString

string

Anslutningssträngen som ska parsas.

Returer

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Varje åtgärd görs minst en gång. Ytterligare försök görs om föregående försök misslyckades med ett återförsöksfel. Antalet ytterligare försök styrs av egenskapen maxRetries som anges i argumentet RetryConfig.

Om mode alternativet är inställt på Fixedgörs återförsöken för den angivna åtgärden under ett angivet antal gånger, med en fast fördröjning mellan varje nytt försök varje gång.

Om mode alternativet är inställt på Exponentialjusteras fördröjningen mellan återförsöken för att öka exponentiellt med varje försök att använda back-off-faktor för effekt 2.

function retry<T>(config: RetryConfig<T>): Promise<T>

Parametrar

config

RetryConfig<T>

Parametrar för att konfigurera omförsöksåtgärd

Returer

Promise<T>

Löfte.

translate(unknown)

Översätter AMQP-felet som tas emot på protokollskiktet eller en SystemError till en MessagingError. Alla andra fel returneras oförändrade.

function translate(err: unknown): MessagingError | Error

Parametrar

err

unknown

Amqp-felet som togs emot.

Returer

MessagingError | Error

MessagingError-objekt.