Fazendaaa/AnilistBot

View on GitHub
docs/API/modules/_main_.html

Summary

Maintainability
Test Coverage
<!doctype html>
<html class="default no-js">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>&quot;main&quot; | anilistbot</title>
    <meta name="description" content="">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
    <div class="tsd-page-toolbar">
        <div class="container">
            <div class="table-wrap">
                <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
                    <div class="field">
                        <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
                        <input id="tsd-search-field" type="text" />
                    </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">anilistbot</a>
                </div>
                <div class="table-cell" id="tsd-widgets">
                    <div id="tsd-filter">
                        <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
                        <div class="tsd-filter-group">
                            <div class="tsd-select" id="tsd-filter-visibility">
                                <span class="tsd-select-label">All</span>
                                <ul class="tsd-select-list">
                                    <li data-value="public">Public</li>
                                    <li data-value="protected">Public/Protected</li>
                                    <li data-value="private" class="selected">All</li>
                                </ul>
                            </div>
                            <input type="checkbox" id="tsd-filter-inherited" checked />
                            <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
                            <input type="checkbox" id="tsd-filter-externals" checked />
                            <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
                            <input type="checkbox" id="tsd-filter-only-exported" />
                            <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
                        </div>
                    </div>
                    <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
                </div>
            </div>
        </div>
    </div>
    <div class="tsd-page-title">
        <div class="container">
            <ul class="tsd-breadcrumb">
                <li>
                    <a href="../globals.html">Globals</a>
                </li>
                <li>
                    <a href="_main_.html">&quot;main&quot;</a>
                </li>
            </ul>
            <h1>External module &quot;main&quot;</h1>
        </div>
    </div>
</header>
<div class="container container-main">
    <div class="row">
        <div class="col-8 col-content">
            <section class="tsd-panel-group tsd-index-group">
                <h2>Index</h2>
                <section class="tsd-panel tsd-index-panel">
                    <div class="tsd-index-content">
                        <section class="tsd-index-section ">
                            <h3>Variables</h3>
                            <ul class="tsd-index-list">
                                <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_main_.html#bot" class="tsd-kind-icon">bot</a></li>
                                <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_main_.html#dbstatus" class="tsd-kind-icon">db<wbr>Status</a></li>
                                <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_main_.html#internationalization" class="tsd-kind-icon">internationalization</a></li>
                                <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_main_.html#redisstorage" class="tsd-kind-icon">redis<wbr>Storage</a></li>
                                <li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported"><a href="_main_.html#usercache" class="tsd-kind-icon">user<wbr>Cache</a></li>
                                <li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_main_.html#usersessionlimit" class="tsd-kind-icon">user<wbr>Session<wbr>Limit</a></li>
                            </ul>
                        </section>
                    </div>
                </section>
            </section>
            <section class="tsd-panel-group tsd-member-group ">
                <h2>Variables</h2>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                    <a name="bot" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagConst">Const</span> bot</h3>
                    <div class="tsd-signature tsd-kind-icon">bot<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Telegraf</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ContextMessageUpdate</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;new Telegraf(process.env.BOT_KEY)</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L25">main.ts:25</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                    <a name="dbstatus" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagLet">Let</span> db<wbr>Status</h3>
                    <div class="tsd-signature tsd-kind-icon">db<wbr>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L46">main.ts:46</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
                    <a name="internationalization" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagConst">Const</span> internationalization</h3>
                    <div class="tsd-signature tsd-kind-icon">internationalization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">I18n</span><span class="tsd-signature-symbol"> =&nbsp;new I18n({useSession: true,allowMissing: true,defaultLanguage: &#x27;en&#x27;,sessionName: &#x27;session&#x27;,directory: join(__dirname, &#x27;../others/locales&#x27;)})</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L37">main.ts:37</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                    <a name="redisstorage" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagConst">Const</span> redis<wbr>Storage</h3>
                    <div class="tsd-signature tsd-kind-icon">redis<wbr>Storage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RedisSession</span><span class="tsd-signature-symbol"> =&nbsp;new RedisSession({getSessionKey,property: &#x27;redis&#x27;,ttl: userSessionLimit,store: {port: null,host: null,url: process.env.REDIS_URL}})</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L27">main.ts:27</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                    <a name="usercache" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagConst">Const</span> user<wbr>Cache</h3>
                    <div class="tsd-signature tsd-kind-icon">user<wbr>Cache<span class="tsd-signature-symbol">:</span> <a href="../classes/_lib_telegram_middleware_usercache_.usercache.html" class="tsd-signature-type">UserCache</a><span class="tsd-signature-symbol"> =&nbsp;new UserCache()</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L44">main.ts:44</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
                    <a name="usersessionlimit" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagConst">Const</span> user<wbr>Session<wbr>Limit</h3>
                    <div class="tsd-signature tsd-kind-icon">user<wbr>Session<wbr>Limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">60</span><span class="tsd-signature-symbol"> =&nbsp;60</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/Fazendaaa/AnilistBot/blob/9dcbaec/src/main.ts#L26">main.ts:26</a></li>
                        </ul>
                    </aside>
                </section>
            </section>
        </div>
        <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
            <nav class="tsd-navigation primary">
                <ul>
                    <li class="globals  ">
                        <a href="../globals.html"><em>Globals</em></a>
                    </li>
                    <li class="current tsd-kind-external-module">
                        <a href="_main_.html">"main"</a>
                    </li>
                </ul>
            </nav>
            <nav class="tsd-navigation secondary menu-sticky">
                <ul class="before-current">
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                        <a href="_main_.html#bot" class="tsd-kind-icon">bot</a>
                    </li>
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                        <a href="_main_.html#dbstatus" class="tsd-kind-icon">db<wbr>Status</a>
                    </li>
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module">
                        <a href="_main_.html#internationalization" class="tsd-kind-icon">internationalization</a>
                    </li>
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                        <a href="_main_.html#redisstorage" class="tsd-kind-icon">redis<wbr>Storage</a>
                    </li>
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
                        <a href="_main_.html#usercache" class="tsd-kind-icon">user<wbr>Cache</a>
                    </li>
                    <li class=" tsd-kind-variable tsd-parent-kind-external-module">
                        <a href="_main_.html#usersessionlimit" class="tsd-kind-icon">user<wbr>Session<wbr>Limit</a>
                    </li>
                </ul>
            </nav>
        </div>
    </div>
</div>
<footer class="with-border-bottom">
    <div class="container">
        <h2>Legend</h2>
        <div class="tsd-legend-group">
            <ul class="tsd-legend">
                <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
                <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
                <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
                <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
                <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
                <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
                <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
                <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
                <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
                <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
                <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
                <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
                <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
                <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
                <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
                <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
                <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
                <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
                <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
            </ul>
        </div>
    </div>
</footer>
<div class="container tsd-generator">
    <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>