@rxap/nest-amqp

<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>nest-rabbitmq</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../styles/style.css"> <link rel="stylesheet" href="../styles/dark.css"> </head> <body> <script> // Blocking script to avoid flickering dark mode // Dark mode toggle button var useDark = window.matchMedia('(prefers-color-scheme: dark)'); var darkModeState = useDark.matches; var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); var $darkModeToggles = document.querySelectorAll('.dark-mode-switch'); var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state'); function checkToggle(check) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].checked = check; } } function toggleDarkMode(state) { if (window.localStorage) { localStorage.setItem('compodoc_darkmode-state', state); } checkToggle(state); const hasClass = document.body.classList.contains('dark'); if (state) { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.add('dark'); } if (!hasClass) { document.body.classList.add('dark'); } } else { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.remove('dark'); } if (hasClass) { document.body.classList.remove('dark'); } } } useDark.addEventListener('change', function (evt) { toggleDarkMode(evt.matches); }); if (darkModeStateLocal) { darkModeState = darkModeStateLocal === 'true'; } toggleDarkMode(darkModeState); </script> <div class="navbar navbar-default navbar-fixed-top d-md-none p-0"> <div class="d-flex"> <a href="../" class="navbar-brand">nest-rabbitmq</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="d-none d-md-block menu"> <compodoc-menu mode="normal"></compodoc-menu> </div>  <div class="content class"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Classes</li> <li class="breadcrumb-item" >ClientRMQExchange</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/lib/client-rmq-exchange.ts</code> </p> <p class="comment"> <h3>Extends</h3> </p> <p class="comment"> <code>ClientProxy</code> </p> <section data-compodoc="block-index"> <h3 id="index">Index</h3> <table class="table table-sm table-bordered index-table"> <tbody> <tr> <td class="col-md-4"> <h6><b>Properties</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Protected</span> <a href="#channel" >channel</a> </li> <li> <span class="modifier">Protected</span> <a href="#client" >client</a> </li> <li> <span class="modifier">Protected</span> <a href="#connection$" >connection$</a> </li> <li> <span class="modifier">Protected</span> <a href="#responseEmitter" >responseEmitter</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Methods</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <span class="modifier">Public</span> <a href="#close" >close</a> </li> <li> <span class="modifier">Public</span> <a href="#connect" >connect</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#consumeChannel" >consumeChannel</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#convertConnectionToPromise" >convertConnectionToPromise</a> </li> <li> <span class="modifier">Public</span> <a href="#createChannel" >createChannel</a> </li> <li> <span class="modifier">Public</span> <a href="#createClient" >createClient</a> </li> <li> <span class="modifier">Protected</span> <a href="#dispatchEvent" >dispatchEvent</a> </li> <li> <span class="modifier">Public</span> <a href="#handleDisconnectError" >handleDisconnectError</a> </li> <li> <span class="modifier">Public</span> <a href="#handleError" >handleError</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#handleMessage" >handleMessage</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#handleMessage" >handleMessage</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#handleMessage" >handleMessage</a> </li> <li> <span class="modifier">Protected</span> <span class="modifier"></span> <a href="#initializeDeserializer" >initializeDeserializer</a> </li> <li> <span class="modifier">Protected</span> <span class="modifier"></span> <a href="#initializeSerializer" >initializeSerializer</a> </li> <li> <span class="modifier">Public</span> <a href="#isConnected" >isConnected</a> </li> <li> <span class="modifier">Public</span> <a href="#mergeDisconnectEvent" >mergeDisconnectEvent</a> </li> <li> <span class="modifier">Protected</span> <a href="#mergeHeaders" >mergeHeaders</a> </li> <li> <span class="modifier">Protected</span> <a href="#parseMessageContent" >parseMessageContent</a> </li> <li> <span class="modifier">Protected</span> <a href="#publish" >publish</a> </li> <li> <span class="modifier">Public</span> <span class="modifier">Async</span> <a href="#setupExchange" >setupExchange</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-constructor"> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(options: <a href="../interfaces/ExchangeRmqOptions.html" target="_self">ExchangeRmqOptions</a>, logger)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="60" class="link-to-prism">src/lib/client-rmq-exchange.ts:60</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>options</td> <td> <code><a href="../interfaces/ExchangeRmqOptions.html" target="_self" >ExchangeRmqOptions</a></code> </td> <td> No </td> </tr> <tr> <td>logger</td> <td> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-properties"> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="channel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>channel</b></span> <a href="#channel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>ChannelWrapper | null</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>null</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="59" class="link-to-prism">src/lib/client-rmq-exchange.ts:59</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="client"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>client</b></span> <a href="#client"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>AmqpConnectionManager | null</code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>null</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="58" class="link-to-prism">src/lib/client-rmq-exchange.ts:58</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="connection$"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>connection$</b></span> <a href="#connection$"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>ReplaySubject<Connection></code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="57" class="link-to-prism">src/lib/client-rmq-exchange.ts:57</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="responseEmitter"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>responseEmitter</b></span> <a href="#responseEmitter"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="60" class="link-to-prism">src/lib/client-rmq-exchange.ts:60</a></div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-methods"> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="close"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>close</b></span> <a href="#close"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>close()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="76" class="link-to-prism">src/lib/client-rmq-exchange.ts:76</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="connect"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>connect</b></span> <a href="#connect"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>connect()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="83" class="link-to-prism">src/lib/client-rmq-exchange.ts:83</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Promise<Connection></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="consumeChannel"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Async</span> <span ><b>consumeChannel</b></span> <a href="#consumeChannel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>consumeChannel(channel: Channel)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="183" class="link-to-prism">src/lib/client-rmq-exchange.ts:183</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>channel</td> <td> <code>Channel</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >any</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="convertConnectionToPromise"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Async</span> <span ><b>convertConnectionToPromise</b></span> <a href="#convertConnectionToPromise"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>convertConnectionToPromise()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="161" class="link-to-prism">src/lib/client-rmq-exchange.ts:161</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>unknown</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="createChannel"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>createChannel</b></span> <a href="#createChannel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>createChannel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="117" class="link-to-prism">src/lib/client-rmq-exchange.ts:117</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Promise<void></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="createClient"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>createClient</b></span> <a href="#createClient"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>createClient()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="126" class="link-to-prism">src/lib/client-rmq-exchange.ts:126</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>AmqpConnectionManager</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="dispatchEvent"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>dispatchEvent</b></span> <a href="#dispatchEvent"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>dispatchEvent(packet: ReadPacket)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="313" class="link-to-prism">src/lib/client-rmq-exchange.ts:313</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>packet</td> <td> <code>ReadPacket</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>Promise<any></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="handleDisconnectError"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>handleDisconnectError</b></span> <a href="#handleDisconnectError"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>handleDisconnectError(client: AmqpConnectionManager)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="204" class="link-to-prism">src/lib/client-rmq-exchange.ts:204</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>client</td> <td> <code>AmqpConnectionManager</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="handleError"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>handleError</b></span> <a href="#handleError"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>handleError(client: AmqpConnectionManager)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="200" class="link-to-prism">src/lib/client-rmq-exchange.ts:200</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>client</td> <td> <code>AmqpConnectionManager</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="handleMessage"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Async</span> <span ><b>handleMessage</b></span> <a href="#handleMessage"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>handleMessage(packet, callback: (packet: WritePacket) => void)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="211" class="link-to-prism">src/lib/client-rmq-exchange.ts:211</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>packet</td> <td> </td> <td> No </td> </tr> <tr> <td>callback</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>Promise<void></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="handleMessage"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Async</span> <span ><b>handleMessage</b></span> <a href="#handleMessage"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>handleMessage(packet, options: Record<string | >, callback: (packet: WritePacket) => void)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="215" class="link-to-prism">src/lib/client-rmq-exchange.ts:215</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>packet</td> <td> </td> <td> No </td> </tr> <tr> <td>options</td> <td> <code>Record<string | ></code> </td> <td> No </td> </tr> <tr> <td>callback</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>Promise<void></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="handleMessage"></a> <span class="name"> <span class="modifier">Public</span> <span class="modifier">Async</span> <span ><b>handleMessage</b></span> <a href="#handleMessage"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>handleMessage(packet, optionsOrCallback: Record<string | > | , callback?: (packet?: WritePacket) => void)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="220" class="link-to-prism">src/lib/client-rmq-exchange.ts:220</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>packet</td> <td> </td> <td> No </td> </tr> <tr> <td>optionsOrCallback</td> <td> <code>Record<string | > | </code> </td> <td> No </td> </tr> <tr> <td>callback</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>Promise<void></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="initializeDeserializer"></a> <span class="name"> <span class="modifier">Protected</span> <span class="modifier"></span> <span ><b>initializeDeserializer</b></span> <a href="#initializeDeserializer"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <span class="modifier-icon icon ion-ios-reset"></span> <code>initializeDeserializer(options: <a href="../interfaces/ExchangeRmqOptions.html" target="_self">ExchangeRmqOptions</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="342" class="link-to-prism">src/lib/client-rmq-exchange.ts:342</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>options</td> <td>