@azure/core-amqp package

Třídy

CbsClient	Popisuje klienta EventHub/ServiceBus Cbs, který komunikuje s koncovým bodem $cbs přes připojení AMQP.
MessagingError	Popisuje základní třídu pro zasílání zpráv Error.
RequestResponseLink	Popisuje odkaz amqp request(sender)-response(receiver), který je vytvořen v relaci amqp.

Rozhraní

AcquireLockProperties	Popisuje vlastnosti, které musí být poskytnuty při získávání zámku.
AmqpAnnotatedMessage	Popisuje AmqpAnnotatedMessage, součást vlastnosti ServiceBusReceivedMessage(as amqpAnnotatedMessage ).
AmqpMessageHeader	Popisuje definovanou sadu standardních vlastností hlavičky zprávy.
AmqpMessageProperties	Popisuje definovanou sadu standardních vlastností zprávy.
CancellableAsyncLock	CancellableAsyncLock poskytuje mechanismus pro vynucení úloh pomocí stejného klíče, aby se spouštěly sériově. Čekající úkoly lze ručně zrušit prostřednictvím abortSignal nebo automaticky zrušit dosažením zadané hodnoty časového limitu.
CbsResponse	Popisuje odpověď CBS.
ConnectionConfig	Popisuje objekt konfigurace připojení, který se vytvoří po analýze připojovacího řetězce EventHub nebo ServiceBus.
ConnectionConfigOptions	Popisuje možnosti, které lze poskytnout při vytváření konfigurace připojení.
ConnectionContextBase	Poskytuje kontextové informace, jako je základní připojení amqp, relace cbs, tokenProvider, konfigurace připojení, datový transformátor atd.
ConnectionProperties	Definuje vlastnosti, které je potřeba nastavit při navazování připojení AMQP.
CreateConnectionContextBaseParameters	Popisuje parametry, které lze zadat k vytvoření kontextu základního připojení.
NetworkSystemError	Popisuje pole v Node.js SystemError. Vynechá pole, která nesouvisejí se síťovými voláními (např. volání systému souborů). Viz https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror.
RetryConfig	Popisuje parametry, které je potřeba nakonfigurovat pro operaci opakování.
RetryOptions	Možnosti zásad opakování, které určují režim, počet opakování, interval opakování atd.
SendRequestOptions	Popisuje možnosti, které lze zadat při odesílání žádosti.
WebSocketOptions	Možnosti konfigurace channelingu připojení AMQP přes webové sokety

Aliasy typu

ParsedOutput

Definuje objekt s možnými vlastnostmi definovanými v T.

Výčty

ConditionErrorNameMapper	Mapuje chybové podmínky amqp na názvy chyb.
ErrorNameConditionMapper	Mapuje názvy chyb na chybové podmínky amqp.
RetryMode	Popisuje typ režimu opakování.
RetryOperationType	Popisuje typ operace opakování.
SystemErrorConditionMapper	Mapuje některé chyby systému na chybové podmínky amqp.
TokenType	Popisuje typ podporovaných tokenů.

Funkce

delay<T>(number, AbortSignalLike, string, T)	Obálka pro setTimeout, která vyřeší příslib po t milisekundách.
isMessagingError(Error | MessagingError)	Určuje, jestli se jedná o chybu MessagingError.
isSystemError(unknown)	Zkontroluje, jestli je zadanou chybou node.js Chyba systému.
parseConnectionString<T>(string)	Analyzuje připojovací řetězec a vrátí objekt typu T. Připojovací řetězce mají následující syntaxi: ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ Whitespace ] Literal [ Whitespace ] Literal ::= ? jakékoli posloupnosti znaků s výjimkou ; nebo = nebo prázdné znaky? Prázdné znaky ::= ? všechny prázdné znaky včetně \r a \n ?
retry<T>(RetryConfig<T>)	Každá operace se pokusí aspoň jednou. Pokud předchozí pokus selhal s opakovatelnou chybou, jsou provedeny další pokusy. Počet dalších pokusů se řídí maxRetries vlastností zadanou v argumentu RetryConfig . Pokud mode je možnost nastavená na Fixed, pak se opakování provádí u dané operace po zadaný počet opakování s pevným zpožděním mezi jednotlivými opakováními pokaždé. Pokud mode je možnost nastavená na Exponential, pak se zpoždění mezi opakovanými pokusy upraví tak, aby se exponenciálně zvýšilo s každým pokusem pomocí faktoru napájení 2.
translate(unknown)	Převede chybu AMQP přijatou na vrstvě protokolu nebo chybu SystemError na MessagingError. Všechny ostatní chyby se vrátí beze chyby.

Podrobnosti funkce

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

Obálka pro setTimeout, která vyřeší příslib po t milisekundách.

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

Parametry

delayInMs

number

Počet milisekund, které se mají zpozdit.

abortSignal

AbortSignalLike

AbortSignal přidružený k operaci obsahující.

abortErrorMsg

string

Chybová zpráva o přerušení související s operací obsahující.

value

T

Hodnota, se kterou se má přeložit po vypršení časového limitu t milisekund.

Návraty

Promise<T | void>

• Vyřešený slib

isMessagingError(Error | MessagingError)

Určuje, jestli se jedná o chybu MessagingError.

function isMessagingError(error: Error | MessagingError): error

Parametry

error

Error | MessagingError

Chyba, která může být Chyba nebo Chyba zasílání zpráv.

Návraty

error

isSystemError(unknown)

Zkontroluje, jestli je zadanou chybou node.js Chyba systému.

function isSystemError(err: unknown): err

Parametry

err

unknown

Objekt, který může obsahovat informace o chybě.

Návraty

err

parseConnectionString<T>(string)

Analyzuje připojovací řetězec a vrátí objekt typu T. Připojovací řetězce mají následující syntaxi:

ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ Whitespace ] Literal [ Whitespace ] Literal ::= ? jakékoli posloupnosti znaků s výjimkou ; nebo = nebo prázdné znaky? Prázdné znaky ::= ? všechny prázdné znaky včetně \r a \n ?

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

Parametry

connectionString

string

Připojovací řetězec, který se má analyzovat.

Návraty

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Každá operace se pokusí aspoň jednou. Pokud předchozí pokus selhal s opakovatelnou chybou, jsou provedeny další pokusy. Počet dalších pokusů se řídí maxRetries vlastností zadanou v argumentu RetryConfig . Pokud mode je možnost nastavená na Fixed, pak se opakování provádí u dané operace po zadaný počet opakování s pevným zpožděním mezi jednotlivými opakováními pokaždé.

Pokud mode je možnost nastavená na Exponential, pak se zpoždění mezi opakovanými pokusy upraví tak, aby se exponenciálně zvýšilo s každým pokusem pomocí faktoru napájení 2.

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

Parametry

config

RetryConfig<T>

Parametry pro konfiguraci operace opakování

Návraty

Promise<T>

Slib.

translate(unknown)

Převede chybu AMQP přijatou na vrstvě protokolu nebo chybu SystemError na MessagingError. Všechny ostatní chyby se vrátí beze chyby.

function translate(err: unknown): MessagingError | Error

Parametry

err

unknown

Došlo k chybě amqp.

Návraty

MessagingError | Error

MessagingError – objekt.