@rxap/nest-amqp
Version:
@rxap/nest-amqp
23 lines (20 loc) • 11 kB
HTML
<html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@rxap/nest-amqp</title><meta name="description" content="Documentation for @rxap/nest-amqp"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@rxap/nest-amqp</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@rxap/nest-amqp</h1></div><div class="tsd-panel tsd-typography"><a id="" class="tsd-anchor"></a><h1 class="tsd-anchor-link"></h1><p>@rxap/nest-amqp</p>
<p><a href="https://www.npmjs.com/package/@rxap/nest-amqp"><img src="https://img.shields.io/npm/v/@rxap/nest-amqp?style=flat-square" alt="npm version"></a>
<a href="https://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="commitizen
friendly"></a>
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" alt="styled with
prettier"></a>
<img src="https://img.shields.io/librariesio/release/npm/@rxap/nest-amqp" alt="Libraries.io dependency status for latest release, scoped npm
package">
<img src="https://img.shields.io/npm/dm/@rxap/nest-amqp" alt="npm">
<img src="https://img.shields.io/npm/l/@rxap/nest-amqp" alt="NPM"> -
<a href="#installation">Installation</a></p>
<ul>
<li><a href="#guides">Guides</a></li>
</ul>
<a id="installation-add-the-package-to-your-workspace-bash-yarn-add" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Installation <strong>Add the package to your workspace:</strong> ```bash yarn add<a href="#installation-add-the-package-to-your-workspace-bash-yarn-add" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>@rxap/nest-amqp</p>
<pre><code><span class="hl-0">**</span><span class="hl-1">Install</span><span class="hl-0"> </span><span class="hl-1">peer</span><span class="hl-0"> </span><span class="hl-2">dependencies</span><span class="hl-0">:** </span><span class="hl-3">```bash yarn add</span><br/><span class="hl-3"> @nestjs/common@10.3.8 @nestjs/config@3.2.2 @nestjs/microservices@10.3.8 @nestjs/terminus@10.2.3 @rxap/nest-utilities@^10.3.8-dev.2 @rxap/utilities@^16.4.1-dev.2 amqp-connection-manager@^4.1.14 amqplib@^0.10.4 joi@17.13.3 rxjs@7.8.1 uuid@^11.0.3 </span>
</code><button>Copy</button></pre>
<a id="guides" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Guides<a href="#guides" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><a id="clientrmqexchange" class="tsd-anchor"></a><h2 class="tsd-anchor-link">ClientRMQExchange<a href="#clientrmqexchange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="typescript"><span class="hl-4">import</span><span class="hl-0"> { </span><span class="hl-1">VaultModule</span><span class="hl-0">, </span><span class="hl-1">AmqpVaultService</span><span class="hl-0"> } </span><span class="hl-4">from</span><span class="hl-0"> </span><span class="hl-3">'@rxap/nest-vault'</span><span class="hl-0">;</span><br/><span class="hl-4">import</span><span class="hl-0"> { </span><span class="hl-1">ClientsModule</span><span class="hl-0"> } </span><span class="hl-4">from</span><span class="hl-0"> </span><span class="hl-3">'@nestjs/microservices'</span><span class="hl-0">;</span><br/><span class="hl-4">import</span><span class="hl-0"> { </span><span class="hl-1">ClientRmqExchangeModuleOptionsFactory</span><span class="hl-0">, </span><span class="hl-1">AMQP_EXCHANGE</span><span class="hl-0"> } </span><span class="hl-4">from</span><span class="hl-0"> </span><span class="hl-3">'@rxap/nest-amqp'</span><span class="hl-0">;</span><br/><span class="hl-4">import</span><span class="hl-0"> { </span><span class="hl-1">Logger</span><span class="hl-0">, </span><span class="hl-1">Module</span><span class="hl-0"> } </span><span class="hl-4">from</span><span class="hl-0"> </span><span class="hl-3">'@nestjs/common'</span><span class="hl-0">;</span><br/><br/><span class="hl-0">@</span><span class="hl-5">Module</span><span class="hl-0">({</span><br/><span class="hl-0"> </span><span class="hl-1">imports:</span><span class="hl-0"> [</span><br/><span class="hl-0"> </span><span class="hl-1">VaultModule</span><span class="hl-0">.</span><span class="hl-5">register</span><span class="hl-0">(),</span><br/><span class="hl-0"> </span><span class="hl-1">ClientsModule</span><span class="hl-0">.</span><span class="hl-5">registerAsync</span><span class="hl-0">({</span><br/><span class="hl-0"> </span><span class="hl-1">clients:</span><span class="hl-0"> [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">name:</span><span class="hl-0"> </span><span class="hl-6">AMQP_EXCHANGE</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-1">useClass:</span><span class="hl-0"> </span><span class="hl-1">ClientRmqExchangeModuleOptionsFactory</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-1">extraProviders:</span><span class="hl-0"> [ </span><span class="hl-1">AmqpVaultService</span><span class="hl-0">, </span><span class="hl-1">Logger</span><span class="hl-0"> ]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-1">isGlobal:</span><span class="hl-0"> </span><span class="hl-7">true</span><br/><span class="hl-0"> })</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0">})</span><br/><span class="hl-4">export</span><span class="hl-0"> </span><span class="hl-7">class</span><span class="hl-0"> </span><span class="hl-8">AppModule</span><span class="hl-0"> { }</span>
</code><button type="button">Copy</button></pre>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#"><span></span></a><a href="#installation-add-the-package-to-your-workspace-bash-yarn-add"><span>Installation <wbr/>Add the package to your workspace: ```bash yarn add</span></a><a href="#guides"><span>Guides</span></a><ul><li><a href="#clientrmqexchange"><span>ClientRMQExchange</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@rxap/nest-amqp</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>