@azure/core-amqp package

Klasy

CbsClient	Opisuje klienta EventHub/ServiceBus Cbs, który komunikuje się z punktem końcowym $cbs za pośrednictwem połączenia AMQP.
MessagingError	Opisuje klasę bazową błędu obsługi komunikatów.
RequestResponseLink	Opisuje link amqp request(sender)-response(receiver), który jest tworzony za pośrednictwem sesji amqp.

Interfejsy

AcquireLockProperties	Opisuje właściwości, które należy podać podczas uzyskiwania blokady.
AmqpAnnotatedMessage	Opisuje właściwość AmqpAnnotatedMessage, część serviceBusReceivedMessage(as amqpAnnotatedMessage ).
AmqpMessageHeader	Opisuje zdefiniowany zestaw standardowych właściwości nagłówka komunikatu.
AmqpMessageProperties	Opisuje zdefiniowany zestaw standardowych właściwości komunikatu.
CancellableAsyncLock	CancellableAsyncLock zapewnia mechanizm wymuszania wykonywania zadań przy użyciu tego samego "klucza", który ma być wykonywany szeregowo. Oczekujące zadania można anulować ręcznie za pośrednictwem elementu abortSignal lub automatycznie anulować przez osiągnięcie podanej wartości limitu czasu.
CbsResponse	Opisuje odpowiedź CBS.
ConnectionConfig	Opisuje obiekt konfiguracji połączenia, który jest tworzony po przeanalizowaniu parametrów połączenia EventHub lub ServiceBus.
ConnectionConfigOptions	Opisuje opcje, które można udostępnić podczas tworzenia konfiguracji połączenia.
ConnectionContextBase	Udostępnia informacje kontekstowe, takie jak podstawowe połączenie amqp, sesja cbs, tokenProvider, konfiguracja połączenia, przekształcanie danych itp.
ConnectionProperties	Definiuje właściwości, które należy ustawić podczas ustanawiania połączenia AMQP.
CreateConnectionContextBaseParameters	Opisuje parametry, które można podać w celu utworzenia podstawowego kontekstu połączenia.
NetworkSystemError	Opisuje pola w Node.js SystemError. Pomija pola, które nie są powiązane z wywołaniami sieci (np. wywołaniami systemu plików). Zobacz https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Opisuje parametry, które należy skonfigurować dla operacji ponawiania.
RetryOptions	Opcje zasad ponawiania, które określają tryb, liczbę ponownych prób, interwał ponawiania prób itp.
SendRequestOptions	Opisuje opcje, które można określić podczas wysyłania żądania.
WebSocketOptions	Opcje konfigurowania kanału połączenia AMQP za pośrednictwem gniazd sieci Web.

Aliasy typu

ParsedOutput

Definiuje obiekt z możliwymi właściwościami zdefiniowanymi w języku T.

Wyliczenia

ConditionErrorNameMapper	Mapuje warunki błędu amqp na nazwy błędów.
ErrorNameConditionMapper	Mapuje nazwy błędów na warunki błędu amqp.
RetryMode	Opisuje typ trybu ponawiania prób
RetryOperationType	Opisuje typ operacji ponawiania.
SystemErrorConditionMapper	Mapuje niektóre błędy SystemErrors na warunki błędu amqp
TokenType	Opisuje typ obsługiwanych tokenów.

Funkcje

delay<T>(number, AbortSignalLike, string, T)	Otoka dla setTimeout, która rozwiązuje obietnicę po t milisekundach.
isMessagingError(Error | MessagingError)	Określa, czy błąd to MessagingError.
isSystemError(unknown)	Sprawdza, czy podany błąd jest błędem node.js SystemError.
parseConnectionString<T>(string)	Analizuje parametry połączenia i zwraca obiekt typu T. Parametry połączenia mają następującą składnię: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? dowolna sekwencja znaków z wyjątkiem ; lub = lub biały znak ? Białe znaki ::= ? wszystkie znaki odstępu, w tym \r i \n ?
retry<T>(RetryConfig<T>)	Każda operacja jest podejmowana co najmniej raz. Dodatkowe próby są podejmowane, jeśli poprzednia próba nie powiodła się z powodu błędu możliwego do ponowienia próby. Liczba dodatkowych prób jest określana przez właściwość podaną maxRetries w argumencie RetryConfig . Jeśli mode opcja jest ustawiona na Fixedwartość , ponowne próby są wykonywane dla danej operacji przez określoną liczbę razy, przy stałym opóźnieniu między każdym ponawiania za każdym razem. Jeśli mode opcja jest ustawiona na Exponentialwartość , opóźnienie między ponawianiami jest dostosowywane w celu zwiększenia wykładniczo przy każdej próbie użycia współczynnika wycofywania mocy 2.
translate(unknown)	Tłumaczy błąd protokołu AMQP odebrany w warstwie protokołu lub Błąd SystemError na błąd MessagingError. Wszystkie inne błędy są zwracane w niezmienionej konfiguracji.

Szczegóły funkcji

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

Otoka dla setTimeout, która rozwiązuje obietnicę po t milisekundach.

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

Parametry

delayInMs

number

Liczba milisekund, które mają być opóźnione.

abortSignal

AbortSignalLike

Wartość abortSignal skojarzona z zawierającą operacją.

abortErrorMsg

string

Komunikat o błędzie przerwania skojarzony z zawierającą operacją.

value

T

Wartość, która ma zostać rozwiązana za pomocą wartości po upłynął limitu czasu t milisekund.

Zwraca

Promise<T | void>

• Rozwiązana obietnica

isMessagingError(Error | MessagingError)

Określa, czy błąd to MessagingError.

function isMessagingError(error: Error | MessagingError): error

Parametry

error

Error | MessagingError

Błąd, który może być błędem lub komunikatemError.

Zwraca

error

isSystemError(unknown)

Sprawdza, czy podany błąd jest błędem node.js SystemError.

function isSystemError(err: unknown): err

Parametry

err

unknown

Obiekt, który może zawierać informacje o błędzie.

Zwraca

err

parseConnectionString<T>(string)

Analizuje parametry połączenia i zwraca obiekt typu T. Parametry połączenia mają następującą składnię:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? dowolna sekwencja znaków z wyjątkiem ; lub = lub biały znak ? Białe znaki ::= ? wszystkie znaki odstępu, w tym \r i \n ?

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

Parametry

connectionString

string

Parametry połączenia, które mają zostać przeanalizowane.

Zwraca

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Każda operacja jest podejmowana co najmniej raz. Dodatkowe próby są podejmowane, jeśli poprzednia próba nie powiodła się z powodu błędu możliwego do ponowienia próby. Liczba dodatkowych prób jest określana przez właściwość podaną maxRetries w argumencie RetryConfig . Jeśli mode opcja jest ustawiona na Fixedwartość , ponowne próby są wykonywane dla danej operacji przez określoną liczbę razy, przy stałym opóźnieniu między każdym ponawiania za każdym razem.

Jeśli mode opcja jest ustawiona na Exponentialwartość , opóźnienie między ponawianiami jest dostosowywane w celu zwiększenia wykładniczo przy każdej próbie użycia współczynnika wycofywania mocy 2.

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

Parametry

config

RetryConfig<T>

Parametry konfigurowania operacji ponawiania próby

Zwraca

Promise<T>

Obietnica.

translate(unknown)

Tłumaczy błąd protokołu AMQP odebrany w warstwie protokołu lub Błąd SystemError na błąd MessagingError. Wszystkie inne błędy są zwracane w niezmienionej konfiguracji.

function translate(err: unknown): MessagingError | Error

Parametry

err

unknown

Odebrano błąd amqp.

Zwraca

MessagingError | Error

MessagingError, obiekt.