@azure/amqp-common package

Klasserna

AsyncLock
AadTokenProvider

Definierar AAD-token (Azure ActiveDirectory)Provider. Detta accepterar följande autentiseringsuppgifter från @azure/ms-rest-nodeauth-paketet:

  • ApplicationTokenCredentials
  • UserTokenCredentials
  • DeviceTokenCredentials
  • MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer

Standarddatatransformator som ska användas av Azure SDK.

MessagingError

Beskriver basklassen för meddelandefel.

RequestResponseLink

Beskriver en amqp request(sender)-response(receiver)-länk som skapas över en amqp-session.

SasTokenProvider
Timeout

Beskriver en timeout-klass som kan vänta under den angivna tiden och sedan lösa/avvisa löftet med det angivna värdet.

Gränssnitt

AsyncLockOptions
ConnectionConfig

Beskriver anslutningskonfigurationsobjektet som skapas efter parsning av en EventHub- eller ServiceBus-anslutningssträng.

ConnectionContextBase
EventHubConnectionConfig

Beskriver anslutningskonfigurationsobjektet som skapas efter parsning av en EventHub-anslutningssträng. Det innehåller också några praktiska metoder för att hämta adressen och målgruppen för olika entiteter.

MessageHeader

Beskriver den definierade uppsättningen standardhuvudegenskaper för meddelandet.

MessageProperties

Beskriver den definierade uppsättningen standardegenskaper för meddelandet.

AmqpMessage

Beskriver AMQP-meddelandet som skickas eller tas emot på kabeln.

AmqpMessageHeader

Beskriver den definierade uppsättningen standardhuvudegenskaper för meddelandet.

AmqpMessageProperties

Beskriver den definierade uppsättningen standardegenskaper för meddelandet.

AsyncLockOptions

Beskriver de alternativ som kan anges för att skapa ett asynkront lås.

CbsResponse

Beskriver CBS-svaret.

ConnectionConfigOptions

Beskriver de alternativ som kan anges när du skapar en anslutningskonfiguration.

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.

DataTransformer

Beskriver de transformeringar som kan utföras för att koda/avkoda data innan de skickas på (eller tar emot dem från) tråden.

Dictionary

Innehåller en ordlista som struktur <Nyckel, Värde> av typ T.

EventHubConnectionStringModel

Beskriver eventhub-anslutningssträngsmodellen.

IotHubConnectionStringModel

Beskriver iothub-anslutningssträngsmodellen.

RetryConfig

Beskriver de parametrar som måste konfigureras för återförsöksåtgärden.

SendRequestOptions

Beskriver de alternativ som kan anges när en begäran skickas.

ServiceBusConnectionStringModel

Beskriver servicebus-anslutningssträngsmodellen.

StorageConnectionStringModel

Beskriver anslutningssträngsmodellen för stroage.

TokenInfo

Innehåller information om token.

TokenProvider

Beskriver bastokenprovidern.

Typaliaser

AsyncLockDoneCallback
Func

Typdeklaration för en funktionstyp där T är indata till funktionen och V är utdata för funktionen.

ParsedOutput

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

Enums

ConditionErrorNameMapper

Mappar amqp-felvillkoren till felnamnen.

ConditionStatusMapper

Mappar villkoren till de numeriska AMQP-svarsstatuskoderna.

ErrorNameConditionMapper

Mappar felnamnen till amqp-felvillkoren.

RetryOperationType

Beskriver typen av återförsöksåtgärd. RetryOperationType

SystemErrorConditionMapper

Mappar vissa SytemErrors till amqp-feltillstånd systemErrorConditionMapper

TokenType

Beskriver typen av token som stöds. TokenType

Funktioner

delay<T>(number, T)

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

executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)

Hämtar en ny instans av asynkront lås med önskade inställningar.

isAmqpError(any)

Avgör om det angivna felobjektet är som ett AmqpError-objekt.

isIotHubConnectionString(string)

Avgör om den angivna anslutningssträngen är en iothub-anslutningssträng.

isSystemError(any)
parseConnectionString<T>(string)

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

Anslutningssträngar har följande syntax:

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

randomNumberFromInterval(number, number)

Genererar ett slumpmässigt tal mellan det angivna intervallet

retry<T>(RetryConfig<T>)

Den försöker linjärt försöka utföra en åtgärd på nytt angivet antal gånger med en angiven fördröjning mellan varje nytt försök. Återförsöken sker bara om felet kan försökas igen.

translate(Error | AmqpError)

Översätter AQMP-felet som tas emot på protokollskiktet eller ett allmänt fel till en MessagingError.

Variabler

defaultLock
isNode

En konstant som anger om miljön är node.js eller webbläsarbaserad.

retryableErrors

Ger en lista över återtagbara AMQP-fel. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

Funktionsdetaljer

delay<T>(number, T)

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

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

Parametrar

t

number

Antalet millisekunder som ska fördröjas.

value

T

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

Returnerar

Promise<T>

  • Löst löfte

executePromisesSequentially(any[], any)

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

Parametrar

promiseFactories

any[]

kickstart

any

Returnerar

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Hämtar en ny instans av asynkront lås med önskade inställningar.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parametrar

options
AsyncLockOptions

Alternativen för asynkront lås.

Returnerar

AsyncLock

isAmqpError(any)

Avgör om det angivna felobjektet är som ett AmqpError-objekt.

function isAmqpError(err: any): boolean

Parametrar

err

any

AmqpError-objektet

Returnerar

boolean

result – true om det är ett AMQP-fel; false annars.

isIotHubConnectionString(string)

Avgör om den angivna anslutningssträngen är en iothub-anslutningssträng.

function isIotHubConnectionString(connectionString: string): boolean

Parametrar

connectionString

string

Anslutningssträngen.

Returnerar

boolean

boolesk.

isSystemError(any)

function isSystemError(err: any): boolean

Parametrar

err

any

Returnerar

boolean

parseConnectionString<T>(string)

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

Anslutningssträngar har följande syntax:

ConnectionString ::= Del { ";" Del } [ ";" ] [ Blanksteg ] 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.

Returnerar

ParsedOutput<T>.

randomNumberFromInterval(number, number)

Genererar ett slumpmässigt tal mellan det angivna intervallet

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

Parametrar

min

number

Minsta antal av intervallet (inklusive).

max

number

Maximalt antal av intervallet (inklusive).

Returnerar

number

retry<T>(RetryConfig<T>)

Den försöker linjärt försöka utföra en åtgärd på nytt angivet antal gånger med en angiven fördröjning mellan varje nytt försök. Återförsöken sker bara om felet kan försökas igen.

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

Parametrar

config

RetryConfig<T>

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

Returnerar

Promise<T>

Löfte<T>.

translate(Error | AmqpError)

Översätter AQMP-felet som tas emot på protokollskiktet eller ett allmänt fel till en MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parametrar

err

Error | AmqpError

Amqp-felet som togs emot.

Returnerar

MessagingError-objekt.

Variable Details

defaultLock

defaultLock: AsyncLock

Typ

isNode

En konstant som anger om miljön är node.js eller webbläsarbaserad.

isNode: boolean

Typ

boolean

retryableErrors

Ger en lista över återtagbara AMQP-fel. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError", "OperationTimeoutError"

retryableErrors: string[]

Typ

string[]