@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 injectable"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Injectables</li> <li class="breadcrumb-item" >RabbitmqOptionsFactory</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/rabbitmq-options-factory.ts</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"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <a href="#config" >config</a> </li> <li> <span class="modifier"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <a href="#logger" >logger</a> </li> <li> <span class="modifier"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <a href="#vault" >vault</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">Async</span> <a href="#build" >build</a> </li> <li> <span class="modifier">Async</span> <a href="#buildUrl" >buildUrl</a> </li> <li> <span class="modifier">Async</span> <a href="#getCredentials" >getCredentials</a> </li> </ul> </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="build"></a> <span class="name"> <span class="modifier">Async</span> <span ><b>build</b></span> <a href="#build"><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>build()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="23" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:23</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code><a href="../interfaces/BaseRmqOptions.html" target="_self" >Promise<BaseRmqOptions></a></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="buildUrl"></a> <span class="name"> <span class="modifier">Async</span> <span ><b>buildUrl</b></span> <a href="#buildUrl"><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>buildUrl()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:71</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Promise<string></code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getCredentials"></a> <span class="name"> <span class="modifier">Async</span> <span ><b>getCredentials</b></span> <a href="#getCredentials"><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>getCredentials()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="50" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:50</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Promise<literal type></code> </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="config"></a> <span class="name"> <span class="modifier"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <span ><b>config</b></span> <a href="#config"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>ConfigService</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @Inject(ConfigService)<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="15" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:15</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="logger"></a> <span class="name"> <span class="modifier"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <span ><b>logger</b></span> <a href="#logger"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>Logger</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @Inject(Logger)<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="18" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:18</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="vault"></a> <span class="name"> <span class="modifier"></span> <span class="modifier">Protected</span> <span class="modifier">Readonly</span> <span ><b>vault</b></span> <a href="#vault"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>RabbitmqVaultService</code> </td> </tr> <tr> <td class="col-md-4"> <b>Decorators : </b> <br /> <code> @Inject(RabbitmqVaultService)<br /> </code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="21" class="link-to-prism">src/lib/rabbitmq-options-factory.ts:21</a></div> </td> </tr> </tbody> </table> </section> </div> <div class="tab-pane fade tab-source-code" id="source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Inject, Injectable, Logger, } from '@nestjs/common'; import { ConfigService } from '@nestjs/config'; import { RabbitmqVaultService } from '@rxap/nest-vault'; import { CoercePrefix } from '@rxap/utilities'; import { BaseRmqOptions } from './options'; @Injectable() export class RabbitmqOptionsFactory { @Inject(ConfigService) protected readonly config!: ConfigService; @Inject(Logger) protected readonly logger!: Logger; @Inject(RabbitmqVaultService) protected readonly vault!: RabbitmqVaultService; async build(): Promise<BaseRmqOptions> { let options: BaseRmqOptions; if (this.config.get('RABBITMQ_DISABLED')) { this.logger.debug('RabbitMQ is disabled', 'RabbitMQModuleConfigFactory'); const host = this.config.getOrThrow('RABBITMQ_HOST'); const port = this.config.getOrThrow('RABBITMQ_PORT'); const vhost = this.config.getOrThrow('RABBITMQ_VHOST'); options = { urls: [ `amqp://${ host }:${ port }/${ vhost }` ], socketOptions: { reconnectTimeInSeconds: 24 * 60 * 60 } }; } else { this.logger.debug('RabbitMQ is enabled', 'RabbitMQModuleConfigFactory'); options = { socketOptions: { findServers: () => this.buildUrl() } }; } return options; } async getCredentials(): Promise<{ username: string, password: string }> { this.logger.verbose('Getting RabbitMQ credentials', 'RabbitMQModuleConfigFactory'); if (this.config.get('RABBITMQ_USERNAME') && this.config.get('RABBITMQ_PASSWORD')) { this.logger.debug('Using username and password from env', 'RabbitMQModuleConfigFactory'); return { username: this.config.getOrThrow('RABBITMQ_USERNAME'), password: this.config.getOrThrow('RABBITMQ_PASSWORD') }; } if (this.config.get('RABBITMQ_VAULT_ROLE')) { this.logger.debug('Using vault to get username and password', 'RabbitMQModuleConfigFactory'); const role = this.config.getOrThrow('RABBITMQ_VAULT_ROLE'); return this.vault.getCredentials(role, true); } throw new Error('No credentials found for RabbitMQ connection'); } async buildUrl(): Promise<string> { this.logger.verbose('Building RabbitMQ url', 'RabbitMQModuleConfigFactory'); if (this.config.get('RABBITMQ_URI')) { this.logger.debug('Using uri from env RABBITMQ_URI', 'RabbitMQModuleConfigFactory'); return this.config.getOrThrow('RABBITMQ_URI'); } const { username, password } = await this.getCredentials(); const host = this.config.getOrThrow('RABBITMQ_HOST'); const port = this.config.getOrThrow('RABBITMQ_PORT'); const vhost = this.config.getOrThrow('RABBITMQ_VHOST'); this.logger.debug( `Using uri amqp://${ username }:*****@${ host }:${ port }${ CoercePrefix(vhost, '/') }`, 'RabbitMQModuleConfigFactory' ); return `amqp://${ username }:${ password }@${ host }:${ port }/${ vhost }`; } } </code></pre> </div> </div> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div>  </div> </div> <label class="dark-mode-switch"> <input type="checkbox"> <span class="slider"> <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg"> <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path> </svg> </span> </label> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable'; var COMPODOC_CURRENT_PAGE_URL = 'RabbitmqOptionsFactory.html'; var MAX_SEARCH_RESULTS = 15; </script> <script> $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); checkToggle(darkModeState); if ($darkModeToggleSwitchers.length > 0) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].addEventListener('change', function (event) { darkModeState = !darkModeState; toggleDarkMode(darkModeState); }); } } </script> <script src="../js/libs/custom-elements.min.js"></script> <script src="../js/libs/lit-html.js"></script> <script src="../js/menu-wc.js" defer></script> <script nomodule src="../js/menu-wc_es5.js" defer></script> <script src="../js/libs/bootstrap-native.js"></script> <script src="../js/libs/es6-shim.min.js"></script> <script src="../js/libs/EventDispatcher.js"></script> <script src="../js/libs/promise.min.js"></script> <script src="../js/libs/zepto.min.js"></script> <script src="../js/compodoc.js"></script> <script src="../js/tabs.js"></script> <script src="../js/menu.js"></script> <script src="../js/libs/clipboard.min.js"></script> <script src="../js/libs/prism.js"></script> <script src="../js/sourceCode.js"></script> <script src="../js/search/search.js"></script> <script src="../js/search/lunr.min.js"></script> <script src="../js/search/search-lunr.js"></script> <script src="../js/search/search_index.js"></script> <script src="../js/lazy-load-graphs.js"></script> </body> </html>