@azure/core-amqp package

Klassen

CbsClient	Beschrijft de EventHub/ServiceBus Cbs-client die met het $cbs-eindpunt praat via de AMQP-verbinding.
MessagingError	Beschrijft de basisklasse voor Berichtfout.
RequestResponseLink	Beschrijft een koppeling amqp request(sender)-response(receiver) die is gemaakt via een amqp-sessie.

Interfaces

AcquireLockProperties	Beschrijft de eigenschappen die moeten worden opgegeven tijdens het verkrijgen van een vergrendeling.
AmqpAnnotatedMessage	Beschrijft de AmqpAnnotatedMessage, onderdeel van de ServiceBusReceivedMessage(als amqpAnnotatedMessage eigenschap).
AmqpMessageHeader	Beschrijft de gedefinieerde set standaardheadereigenschappen van het bericht.
AmqpMessageProperties	Beschrijft de gedefinieerde set standaardeigenschappen van het bericht.
CancellableAsyncLock	CancellableAsyncLock biedt een mechanisme om af te dwingen dat taken met dezelfde 'sleutel' serieel worden uitgevoerd. Taken in behandeling kunnen handmatig worden geannuleerd via een abortSignal of automatisch worden geannuleerd door een opgegeven time-outwaarde te bereiken.
CbsResponse	Hierin wordt het CBS-antwoord beschreven.
ConnectionConfig	Beschrijft het verbindingsconfiguratieobject dat wordt gemaakt na het parseren van een EventHub- of ServiceBus-connection string.
ConnectionConfigOptions	Hierin worden de opties beschreven die kunnen worden geboden tijdens het maken van een verbindingsconfiguratie.
ConnectionContextBase	Biedt contextuele informatie, zoals de onderliggende amqp-verbinding, cbs-sessie, tokenProvider, verbindingsconfiguratie, gegevenstransformatie, enzovoort.
ConnectionProperties	Definieert de eigenschappen die moeten worden ingesteld tijdens het tot stand brengen van de AMQP-verbinding.
CreateConnectionContextBaseParameters	Beschrijft de parameters die kunnen worden opgegeven om de context van de basisverbinding te maken.
NetworkSystemError	Beschrijft de velden op een Node.js SystemError. Hiermee worden velden weggelaten die niet zijn gerelateerd aan netwerkoproepen (bijvoorbeeld bestandssysteemoproepen). Zie https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Beschrijft de parameters die moeten worden geconfigureerd voor de bewerking voor opnieuw proberen.
RetryOptions	Beleidsopties voor opnieuw proberen die de modus, het aantal nieuwe pogingen, het interval voor opnieuw proberen, enzovoort bepalen.
SendRequestOptions	Beschrijft de opties die kunnen worden opgegeven tijdens het verzenden van een aanvraag.
WebSocketOptions	Opties voor het configureren van de channeling van de AMQP-verbinding via Web Sockets.

Type-aliassen

ParsedOutput

Hiermee definieert u een object met mogelijke eigenschappen die zijn gedefinieerd in T.

Enums

ConditionErrorNameMapper	Wijst de amqp-foutvoorwaarden toe aan de foutnamen.
ErrorNameConditionMapper	Wijst de foutnamen toe aan de amqp-foutvoorwaarden.
RetryMode	Beschrijft het type Modus voor opnieuw proberen
RetryOperationType	Beschrijft het bewerkingstype voor opnieuw proberen.
SystemErrorConditionMapper	Wijst sommige SystemErrors toe aan amqp-foutvoorwaarden
TokenType	Beschrijft het type ondersteunde tokens.

Functies

delay<T>(number, AbortSignalLike, string, T)	Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.
isMessagingError(Error | MessagingError)	Bepaalt of een fout een MessagingError is.
isSystemError(unknown)	Controleert of de opgegeven fout een node.js SystemError is.
parseConnectionString<T>(string)	Parseert de connection string en retourneert een object van het type T. Verbindingsreeksen hebben de volgende syntaxis: ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? elke reeks tekens, met uitzondering van ; of = of witruimte? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n ?
retry<T>(RetryConfig<T>)	Elke bewerking wordt ten minste één keer uitgevoerd. Er worden extra pogingen gedaan als de vorige poging is mislukt met een fout die opnieuw kan worden geprobeerd. Het aantal extra pogingen wordt bepaald door de maxRetries eigenschap die is opgegeven in het RetryConfig argument. Als mode de optie is ingesteld Fixedop , worden de nieuwe pogingen voor de opgegeven bewerking een opgegeven aantal keren uitgevoerd, met een vaste vertraging tussen elke nieuwe poging elke keer. Als mode de optie is ingesteld op Exponential, wordt de vertraging tussen nieuwe pogingen aangepast om exponentieel toe te nemen bij elke poging met behulp van de back-off-factor van macht 2.
translate(unknown)	Vertaalt de AMQP-fout die is ontvangen op de protocollaag of een SystemError in een MessagingError. Alle andere fouten worden ongewijzigd geretourneerd.

Functiedetails

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

Een wrapper voor setTimeout waarmee een belofte na t milliseconden wordt omgezet.

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

Parameters

delayInMs

number

Het aantal milliseconden dat moet worden vertraagd.

abortSignal

AbortSignalLike

De abortSignal die is gekoppeld aan de bevattende bewerking.

abortErrorMsg

string

Het foutbericht over afbreken dat is gekoppeld aan de actieve bewerking.

value

T

De waarde die moet worden omgezet na een time-out van t milliseconden.

Retouren

Promise<T | void>

• Belofte opgelost

isMessagingError(Error | MessagingError)

Bepaalt of een fout een MessagingError is.

function isMessagingError(error: Error | MessagingError): error

Parameters

error

Error | MessagingError

Een fout die een Error of een MessagingError kan zijn.

Retouren

error

isSystemError(unknown)

Controleert of de opgegeven fout een node.js SystemError is.

function isSystemError(err: unknown): err

Parameters

err

unknown

Een object dat foutinformatie kan bevatten.

Retouren

err

parseConnectionString<T>(string)

Parseert de connection string en retourneert een object van het type T. Verbindingsreeksen hebben de volgende syntaxis:

ConnectionString ::= Part ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? elke reeks tekens, met uitzondering van ; of = of witruimte? Witruimte ::= ? alle witruimtetekens, inclusief \r en \n ?

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

Parameters

connectionString

string

De connection string worden geparseerd.

Retouren

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Elke bewerking wordt ten minste één keer uitgevoerd. Er worden extra pogingen gedaan als de vorige poging is mislukt met een fout die opnieuw kan worden geprobeerd. Het aantal extra pogingen wordt bepaald door de maxRetries eigenschap die is opgegeven in het RetryConfig argument. Als mode de optie is ingesteld Fixedop , worden de nieuwe pogingen voor de opgegeven bewerking een opgegeven aantal keren uitgevoerd, met een vaste vertraging tussen elke nieuwe poging elke keer.

Als mode de optie is ingesteld op Exponential, wordt de vertraging tussen nieuwe pogingen aangepast om exponentieel toe te nemen bij elke poging met behulp van de back-off-factor van macht 2.

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

Parameters

config

RetryConfig<T>

Parameters voor het configureren van de bewerking voor opnieuw proberen

Retouren

Promise<T>

Belofte.

translate(unknown)

Vertaalt de AMQP-fout die is ontvangen op de protocollaag of een SystemError in een MessagingError. Alle andere fouten worden ongewijzigd geretourneerd.

function translate(err: unknown): MessagingError | Error

Parameters

err

unknown

De amqp-fout die is ontvangen.

Retouren

MessagingError | Error

MessagingError-object.