@azure/amqp-common package

Klasy

AsyncLock
AadTokenProvider	Definiuje tokenProvider usługi AAD (Azure ActiveDirectory). Akceptuje to następujące poświadczenia z pakietu `@azure/ms-rest-nodeauth`: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials Poświadczenia MSIToken (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Domyślny transformator danych, który będzie używany przez zestaw Azure SDK.
MessagingError	Opisuje klasę podstawową dla błędu obsługi komunikatów.
RequestResponseLink	Opisuje link amqp request(sender)-response(receiver), który jest tworzony za pośrednictwem sesji amqp.
SasTokenProvider
Timeout	Opisuje klasę Limit czasu, która może poczekać na określoną ilość czasu, a następnie rozwiązać/odrzucić obietnicę z daną wartością.

Interfejsów

AsyncLockOptions
ConnectionConfig	Opisuje obiekt konfiguracji połączenia, który jest tworzony po przeanalizowaniu parametrów połączenia EventHub lub ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Opisuje obiekt konfiguracji połączenia, który jest tworzony po przeanalizowaniu parametrów połączenia usługi EventHub. Zapewnia również pewne wygodne metody uzyskiwania adresu i odbiorców dla różnych jednostek.
MessageHeader	Opisuje zdefiniowany zestaw standardowych właściwości nagłówka komunikatu.
MessageProperties	Opisuje zdefiniowany zestaw standardowych właściwości komunikatu.
AmqpMessage	Opisuje komunikat PROTOKOŁU AMQP, który jest wysyłany lub odbierany w sieci.
AmqpMessageHeader	Opisuje zdefiniowany zestaw standardowych właściwości nagłówka komunikatu.
AmqpMessageProperties	Opisuje zdefiniowany zestaw standardowych właściwości komunikatu.
AsyncLockOptions	Opisuje opcje, które można udostępnić w celu utworzenia blokady asynchronicznych.
CbsResponse	Opisuje odpowiedź CBS.
ConnectionConfigOptions	Opisuje opcje, które można udostępnić podczas tworzenia konfiguracji połączenia.
ConnectionProperties	Definiuje właściwości, które należy ustawić podczas nawiązywania połączenia amQP.
CreateConnectionContextBaseParameters	Opisuje parametry, które można podać w celu utworzenia kontekstu połączenia podstawowego.
DataTransformer	Opisuje przekształcenia, które można wykonać w celu kodowania/dekodowania danych przed wysłaniem ich do (lub odebraniem ich z) przewodu.
Dictionary	Udostępnia słownik, taki jak struktura <klucz, wartość> typu T.
EventHubConnectionStringModel	Opisuje model parametrów połączenia usługi EventHub.
IotHubConnectionStringModel	Opisuje model parametrów połączenia iothub.
RetryConfig	Opisuje parametry, które należy skonfigurować dla operacji ponawiania.
SendRequestOptions	Opisuje opcje, które można określić podczas wysyłania żądania.
ServiceBusConnectionStringModel	Opisuje model parametrów połączenia usługi ServiceBus.
StorageConnectionStringModel	Opisuje model parametrów połączeniastroage.
TokenInfo	Zawiera informacje o tokenie.
TokenProvider	Opisuje podstawowego dostawcę tokenu.

Aliasy typu

AsyncLockDoneCallback
Func	Deklaracja typu dla typu funkcji, gdzie T jest wejściem do funkcji, a V jest wyjściem funkcji.
ParsedOutput	Definiuje obiekt z możliwymi właściwościami zdefiniowanymi w języku T.

Enums

ConditionErrorNameMapper	Mapuje warunki błędu amqp na nazwy błędów.
ConditionStatusMapper	Mapuje warunki na liczbowe kody stanu odpowiedzi protokołu AMQP.
ErrorNameConditionMapper	Mapuje nazwy błędów na warunki błędu amqp.
RetryOperationType	Opisuje typ operacji ponawiania. RetryOperationType
SystemErrorConditionMapper	Mapuje niektóre błędy SytemErrors na warunki błędu amqp SystemErrorConditionMapper
TokenType	Opisuje typ obsługiwanych tokenów. Typ tokenu

Functions

delay<T>(number, T)	Otoka setTimeout, która rozwiązuje obietnicę po milisekundach.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Pobiera nowe wystąpienie blokady asynchronicznego z żądanymi ustawieniami.
isAmqpError(any)	Określa, czy dany obiekt błędu jest jak obiekt AmqpError.
isIotHubConnectionString(string)	Określa, czy podane parametry połączenia są parametrami połączenia iothub.
isSystemError(any)
parseConnectionString<T>(string)	Analizuje parametry połączenia i zwraca obiekt typu T. Parametry połączenia mają następującą składnię: ConnectionString ::= Part { ";" Część } [ ";" ] [ Biały znak ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literał [ WhiteSpace ] Literał ::= ? dowolna sekwencja znaków z wyjątkiem ; lub = lub WhiteSpace ? Biała przestrzeń ::= ? wszystkie znaki odstępu, w tym \r i \n ?
randomNumberFromInterval(number, number)	Generuje losową liczbę między danym interwałem
retry<T>(RetryConfig<T>)	Podejmie próbę liniowo ponowić próbę wykonania operacji określonej liczbie razy z określonym opóźnieniem między poszczególnymi ponownymi próbami. Ponawianie prób nastąpi tylko wtedy, gdy błąd można ponowić próbę.
translate(Error \| AmqpError)	Tłumaczy błąd AQMP odebrany w warstwie protokołu lub ogólny błąd w błąd messagingError.

Zmiennych

defaultLock
isNode	Stała wskazująca, czy środowisko jest node.js czy przeglądarkowe.
retryableErrors	Zawiera listę powtarzalnych błędów AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

Szczegóły funkcji

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Parametry

t: number

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

value: T

Wartość, która ma zostać rozpoznana po przekroczeniu limitu czasu t milisekund.

Zwraca

Promise<T>

Rozwiązana obietnica

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

Parametry

promiseFactories: any[]

kickstart: any

Zwraca

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Pobiera nowe wystąpienie blokady asynchronicznego z żądanymi ustawieniami.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parametry

options: AsyncLockOptions

Opcje blokady asynchronicznego.

Zwraca

AsyncLock

isAmqpError(any)

Określa, czy dany obiekt błędu jest jak obiekt AmqpError.

function isAmqpError(err: any): boolean

Parametry

err: any

Obiekt AmqpError

Zwraca

boolean

result — true, jeśli jest to błąd protokołu AMQP; false w przeciwnym razie.

isIotHubConnectionString(string)

Określa, czy podane parametry połączenia są parametrami połączenia iothub.

function isIotHubConnectionString(connectionString: string): boolean

Parametry

connectionString: string

Parametry połączenia.

Zwraca

boolean

boolowski.

isSystemError(any)

function isSystemError(err: any): boolean

Parametry

err: any

Zwraca

boolean

parseConnectionString<T>(string)

Analizuje parametry połączenia i zwraca obiekt typu T.

Parametry połączenia mają następującą składnię:

ConnectionString ::= Part { ";" Część } [ ";" ] [ Biały znak ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literał [ WhiteSpace ] Literał ::= ? dowolna sekwencja znaków z wyjątkiem ; lub = lub WhiteSpace ? Biała przestrzeń ::= ? 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<T>.

randomNumberFromInterval(number, number)

Generuje losową liczbę między danym interwałem

function randomNumberFromInterval(min: number, max: number): number

Parametry

min: number

Minimalna liczba zakresu (włącznie).

max: number

Maksymalna liczba zakresów (włącznie).

Zwraca

number

retry<T>(RetryConfig<T>)

Podejmie próbę liniowo ponowić próbę wykonania operacji określonej liczbie razy z określonym opóźnieniem między poszczególnymi ponownymi próbami. Ponawianie prób nastąpi tylko wtedy, gdy błąd można ponowić próbę.

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

Parametry

config: RetryConfig<T>

Parametry do konfigurowania operacji ponawiania prób.

Zwraca

Promise<T>

Obietnica<T>.

translate(Error | AmqpError)

Tłumaczy błąd AQMP odebrany w warstwie protokołu lub ogólny błąd w błąd messagingError.

function translate(err: Error | AmqpError): MessagingError

Parametry

err: Error | AmqpError

Odebrano błąd amqp.

Zwraca

MessagingError

MessagingError, obiekt.

Variable Details

defaultLock

defaultLock: AsyncLock

Typ

AsyncLock

isNode

Stała wskazująca, czy środowisko jest node.js czy przeglądarkowe.

isNode: boolean

Typ

boolean

retryableErrors

Zawiera listę powtarzalnych błędów AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

retryableErrors: string[]

Typ

string[]

Opinia

Czy ta strona była pomocna?