@azure/amqp-common package

Třídy

AsyncLock
AadTokenProvider	Definuje AAD (Azure ActiveDirectory) TokenProvider. To přijímá následující přihlašovací údaje z balíčku `@azure/ms-rest-nodeauth`: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Výchozí datový transformátor, který bude používat sada Azure SDK.
MessagingError	Popisuje základní třídu chyby zasílání zpráv.
RequestResponseLink	Popisuje odkaz amqp request(sender)-response(receiver) vytvořený v relaci amqp.
SasTokenProvider
Timeout	Popisuje třídu časového limitu, která může čekat na zadanou dobu a pak vyřešit nebo odmítnout příslib s danou hodnotou.

Rozhraní

AsyncLockOptions
ConnectionConfig	Popisuje objekt konfigurace připojení vytvořený po analýze připojovacího řetězce EventHub nebo ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Popisuje objekt konfigurace připojení vytvořený po analýze připojovacího řetězce EventHubu. Poskytuje také některé metody usnadnění získání adresy a cílové skupiny pro různé entity.
MessageHeader	Popisuje definovanou sadu standardních vlastností záhlaví zprávy.
MessageProperties	Popisuje definovanou sadu standardních vlastností zprávy.
AmqpMessage	Popisuje zprávu AMQP, která je odeslána nebo přijata v přenosu.
AmqpMessageHeader	Popisuje definovanou sadu standardních vlastností záhlaví zprávy.
AmqpMessageProperties	Popisuje definovanou sadu standardních vlastností zprávy.
AsyncLockOptions	Popisuje možnosti, které lze poskytnout k vytvoření asynchronního zámku.
CbsResponse	Popisuje odpověď CBS.
ConnectionConfigOptions	Popisuje možnosti, které lze poskytnout při vytváření konfigurace připojení.
ConnectionProperties	Definuje vlastnosti, které je potřeba nastavit při navazování připojení AMQP.
CreateConnectionContextBaseParameters	Popisuje parametry, které lze poskytnout k vytvoření kontextu základního připojení.
DataTransformer	Popisuje transformace, které je možné provést za účelem kódování nebo dekódování dat před jejich odesláním (nebo příjmem z) drátu.
Dictionary	Poskytuje slovník, jako je struktura <klíč, hodnota> typu T.
EventHubConnectionStringModel	Popisuje model připojovacího řetězce eventhubu.
IotHubConnectionStringModel	Popisuje model připojovacího řetězce iotHubu.
RetryConfig	Popisuje parametry, které je potřeba nakonfigurovat pro operaci opakování.
SendRequestOptions	Popisuje možnosti, které lze zadat při odesílání požadavku.
ServiceBusConnectionStringModel	Popisuje model připojovacího řetězce služby Servicebus.
StorageConnectionStringModel	Popisuje model připojovacího řetězce.
TokenInfo	Poskytuje informace o tokenu.
TokenProvider	Popisuje zprostředkovatele základního tokenu.

Aliasy typu

AsyncLockDoneCallback
Func	Deklarace typu pro typ funkce, kde T je vstupem funkce a V je výstupem funkce.
ParsedOutput	Definuje objekt s možnými vlastnostmi definovanými v T.

Výčty

ConditionErrorNameMapper	Mapuje chybové podmínky amqp na názvy chyb.
ConditionStatusMapper	Namapuje podmínky na číselné stavové kódy odpovědí AMQP.
ErrorNameConditionMapper	Mapuje názvy chyb na chybové stavy amqp.
RetryOperationType	Popisuje typ operace opakování. RetryOperationType
SystemErrorConditionMapper	Mapuje některé chyby SytemErrors na amqp chybové podmínky SystemErrorConditionMapper
TokenType	Popisuje typ podporovaných tokenů. Typ tokenu

Funkce

delay<T>(number, T)	Obálka pro setTimeout, která vyřeší příslib po milisekundách.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Získá novou instanci asynchronního zámku s požadovaným nastavením.
isAmqpError(any)	Určuje, zda daný objekt chyby je jako AmqpError objekt.
isIotHubConnectionString(string)	Určuje, jestli je daný připojovací řetězec připojovacím řetězcem iotHubu.
isSystemError(any)
parseConnectionString<T>(string)	Analyzuje připojovací řetězec a vrátí objekt typu T. Připojovací řetězce mají následující syntaxi: ConnectionString ::= Část { ";" Část } [ ";" ] [ Prázdné znaky ] Část ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? libovolná posloupnost znaků s výjimkou ; nebo = nebo prázdné znaky? Prázdné znaky ::= ? všechny prázdné znaky včetně \r a \n?
randomNumberFromInterval(number, number)	Vygeneruje náhodné číslo mezi daným intervalem.
retry<T>(RetryConfig<T>)	Pokusí se lineární opakování operace s určeným počtem opakování s určeným zpožděním mezi jednotlivými opakováními. Opakování proběhne pouze v případě, že je chyba opakovatelná.
translate(Error \| AmqpError)	Přeloží chybu AQMP přijatou ve vrstvě protokolu nebo obecnou chybu do chyby zasílání zpráv.

Proměnné

defaultLock
isNode	Konstanta, která ukazuje, zda je prostředí node.js nebo založené na prohlížeči.
retryableErrors	Poskytuje seznam opakovatelných chyb AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

Podrobnosti funkce

delay<T>(number, T)

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

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

Parametry

t: number

Počet milisekund, které mají být zpožděny.

value: T

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

Návraty

Promise<T>

Vyřešený slib

executePromisesSequentially(any[], any)

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

Parametry

promiseFactories: any[]

kickstart: any

Návraty

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Získá novou instanci asynchronního zámku s požadovaným nastavením.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parametry

options: AsyncLockOptions

Možnosti asynchronního uzamčení.

Návraty

AsyncLock

isAmqpError(any)

Určuje, zda daný objekt chyby je jako AmqpError objekt.

function isAmqpError(err: any): boolean

Parametry

err: any

Objekt AmqpError

Návraty

boolean

výsledek – true, pokud se jedná o chybu AMQP; false jinak.

isIotHubConnectionString(string)

Určuje, jestli je daný připojovací řetězec připojovacím řetězcem iotHubu.

function isIotHubConnectionString(connectionString: string): boolean

Parametry

connectionString: string

Připojovací řetězec.

Návraty

boolean

booleovský.

isSystemError(any)

function isSystemError(err: any): boolean

Parametry

err: any

Návraty

boolean

parseConnectionString<T>(string)

Analyzuje připojovací řetězec a vrátí objekt typu T.

Připojovací řetězce mají následující syntaxi:

ConnectionString ::= Část { ";" Část } [ ";" ] [ Prázdné znaky ] Část ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? libovolná posloupnost 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<T>.

randomNumberFromInterval(number, number)

Vygeneruje náhodné číslo mezi daným intervalem.

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

Parametry

min: number

Minimální počet rozsahu (včetně).

max: number

Maximální počet rozsahu (včetně).

Návraty

number

retry<T>(RetryConfig<T>)

Pokusí se lineární opakování operace s určeným počtem opakování s určeným zpožděním mezi jednotlivými opakováními. Opakování proběhne pouze v případě, že je chyba opakovatelná.

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

Parametry

config: RetryConfig<T>

Parametry pro konfiguraci operace opakování

Návraty

Promise<T>

Slib<T>.

translate(Error | AmqpError)

Přeloží chybu AQMP přijatou ve vrstvě protokolu nebo obecnou chybu do chyby zasílání zpráv.

function translate(err: Error | AmqpError): MessagingError

Parametry

err: Error | AmqpError

Byla přijata chyba amqp.

Návraty

MessagingError

Objekt MessagingError.

Variable Details

defaultLock

defaultLock: AsyncLock

Typ

AsyncLock

isNode

Konstanta, která ukazuje, zda je prostředí node.js nebo založené na prohlížeči.

isNode: boolean

Typ

boolean

retryableErrors

Poskytuje seznam opakovatelných chyb AMQP. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

retryableErrors: string[]

Typ

string[]

Váš názor

Byla tato stránka užitečná?