<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>hometask documentation</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">
<link rel="stylesheet" href="../styles/readthedocs.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">hometask documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</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="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content miscellaneous-variables">
<div class="content-data">
<ol class="breadcrumb">
<li>Miscellaneous</li>
<li>Variables</li>
</ol>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/page-meta.dto.ts" ><b>allowedProperties</b> (src/.../page-meta.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/page.dto.ts" ><b>allowedProperties</b> (src/.../page.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/paper.dto.ts" ><b>allowedProperties</b> (src/.../paper.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/request.dto.ts" ><b>allowedProperties</b> (src/.../request.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/search-q.dto.ts" ><b>allowedProperties</b> (src/.../search-q.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/search-result.dto.ts" ><b>allowedProperties</b> (src/.../search-result.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/elastic/es-hit.dto.ts" ><b>allowedProperties</b> (src/.../es-hit.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/elastic/es-query.dto.ts" ><b>allowedProperties</b> (src/.../es-query.dto.ts)</a>
</li>
<li>
<a href="#allowedProperties" title="src/core/domain/dtos/elastic/es-response.dto.ts" ><b>allowedProperties</b> (src/.../es-response.dto.ts)</a>
</li>
<li>
<a href="#configuration" title="src/infrastructure/config/env.objects.ts" ><b>configuration</b> (src/.../env.objects.ts)</a>
</li>
<li>
<a href="#IS_PUBLIC_KEY" title="src/core/decorators/public.decorator.ts" ><b>IS_PUBLIC_KEY</b> (src/.../public.decorator.ts)</a>
</li>
<li>
<a href="#modulesList" title="src/infrastructure/modules/app.module.ts" ><b>modulesList</b> (src/.../app.module.ts)</a>
</li>
<li>
<a href="#Public" title="src/core/decorators/public.decorator.ts" ><b>Public</b> (src/.../public.decorator.ts)</a>
</li>
<li>
<a href="#Roles" title="src/core/decorators/roles.decorator.ts" ><b>Roles</b> (src/.../roles.decorator.ts)</a>
</li>
<li>
<a href="#ROLES_KEY" title="src/core/decorators/roles.decorator.ts" ><b>ROLES_KEY</b> (src/.../roles.decorator.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/page-meta.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['total', 'pagenum', 'order', 'hasNext', 'hasPrev', 'pagesize']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/page.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['data', 'meta']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/paper.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['id', 'title', 'authors', 'topic', 'summary', 'tags', 'content']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/request.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['query', 'es_query']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/search-q.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['query', 'pagen', 'limit', 'order']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/search-result.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['data', 'status']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/elastic/es-hit.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['sort', '_source', '_score']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/elastic/es-query.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['size', 'query', 'pit', 'sort']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/domain/dtos/elastic/es-response.dto.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="allowedProperties"></a>
<span class="name">
<span ><b>allowedProperties</b></span>
<a href="#allowedProperties"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code>[]</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>['took', 'timed_out', '_shards', 'hits', 'pit_id']</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>List of allowed properties in this DTO</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/infrastructure/config/env.objects.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="configuration"></a>
<span class="name">
<span ><b>configuration</b></span>
<a href="#configuration"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(): any => ({
VirtualBankOptions: {
transaction_commission: process.env.TRANSACTION_COMMISSION,
widraw_commission: process.env.WIDRAW_COMMISSION,
deposit_fee_per_minute: process.env.DEPOSIT_FEE_PER_MINUTE,
},
})</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>configuration function</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/decorators/public.decorator.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="IS_PUBLIC_KEY"></a>
<span class="name">
<span ><b>IS_PUBLIC_KEY</b></span>
<a href="#IS_PUBLIC_KEY"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>'isPublic'</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>key for public state</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="Public"></a>
<span class="name">
<span ><b>Public</b></span>
<a href="#Public"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>() => SetMetadata(IS_PUBLIC_KEY, true)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>decorates method as public</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/infrastructure/modules/app.module.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="modulesList"></a>
<span class="name">
<span ><b>modulesList</b></span>
<a href="#modulesList"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>Object.keys(modules).map(moduleIndex => modules[moduleIndex as keyof typeof modules])</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>application modules list</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/core/decorators/roles.decorator.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="Roles"></a>
<span class="name">
<span ><b>Roles</b></span>
<a href="#Roles"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(...roles: Role[]) => SetMetadata(ROLES_KEY, roles)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>retuns a list of defined roles</p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="ROLES_KEY"></a>
<span class="name">
<span ><b>ROLES_KEY</b></span>
<a href="#ROLES_KEY"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>'roles'</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>keys of roles</p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</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>
<!-- END CONTENT -->
</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 = 'miscellaneous-variables';
var COMPODOC_CURRENT_PAGE_URL = 'variables.html';
var MAX_SEARCH_RESULTS = 15;
</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>