stoatchat/javascript-client-sdk
1
0
Fork 0
mirror of https://github.com/stoatchat/javascript-client-sdk.git synced 2026-07-20 20:16:06 -04:00
Code Issues 9 Packages Projects Releases 6 Wiki Activity
Files
22d7ad1bb71457149a38e7de2186a7eccdeea0b3
javascript-client-sdk/modules/Client.html
T

280 lines
12 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Client | revolt.js</title>
<meta name="description" content="Documentation for revolt.js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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.json" 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">revolt.js</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>
</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="../modules.html">revolt.js</a>
</li>
<li>
<a href="Client.html">Client</a>
</li>
</ul>
<h1>Module Client</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/Client.Client-1.html" class="tsd-kind-icon">Client</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Client.ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="Client.html#FileArgs" class="tsd-kind-icon">File<wbr>Args</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="Client.html#Session" class="tsd-kind-icon">Session</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="Client.html#RE_MENTIONS" class="tsd-kind-icon">RE_<wbr>MENTIONS</a></li>
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="Client.html#RE_SPOILER" class="tsd-kind-icon">RE_<wbr>SPOILER</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="FileArgs" class="tsd-anchor"></a>
<h3>File<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">File<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>max_side<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span>allowAnimation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>fallback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/44f4af8/src/Client.ts#L127">src/Client.ts:127</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="Session" class="tsd-anchor"></a>
<h3>Session</h3>
<div class="tsd-signature tsd-kind-icon">Session<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/44f4af8/src/Client.ts#L138">src/Client.ts:138</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</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-module">
<a name="RE_MENTIONS" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> RE_<wbr>MENTIONS</h3>
<div class="tsd-signature tsd-kind-icon">RE_<wbr>MENTIONS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/44f4af8/src/Client.ts#L120">src/Client.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Regular expression for mentions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="RE_SPOILER" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> RE_<wbr>SPOILER</h3>
<div class="tsd-signature tsd-kind-icon">RE_<wbr>SPOILER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/44f4af8/src/Client.ts#L125">src/Client.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Regular expression for spoilers.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="Client.html">Client</a>
</li>
<li class=" tsd-kind-module">
<a href="config.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="globals.html">globals</a>
</li>
<li class=" tsd-kind-module">
<a href="index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Bots.html">maps/<wbr>Bots</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Channels.html">maps/<wbr>Channels</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Collection.html">maps/<wbr>Collection</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Emojis.html">maps/<wbr>Emojis</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Members.html">maps/<wbr>Members</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Messages.html">maps/<wbr>Messages</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Servers.html">maps/<wbr>Servers</a>
</li>
<li class=" tsd-kind-module">
<a href="maps_Users.html">maps/<wbr>Users</a>
</li>
<li class=" tsd-kind-module">
<a href="permissions_calculator.html">permissions/calculator</a>
</li>
<li class=" tsd-kind-module">
<a href="permissions_definitions.html">permissions/definitions</a>
</li>
<li class=" tsd-kind-module">
<a href="util_Unreads.html">util/<wbr>Unreads</a>
</li>
<li class=" tsd-kind-module">
<a href="util_null.html">util/null</a>
</li>
<li class=" tsd-kind-module">
<a href="websocket_client.html">websocket/client</a>
</li>
<li class=" tsd-kind-module">
<a href="websocket_notifications.html">websocket/notifications</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/Client.Client-1.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/Client.ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="Client.html#FileArgs" class="tsd-kind-icon">File<wbr>Args</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="Client.html#Session" class="tsd-kind-icon">Session</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="Client.html#RE_MENTIONS" class="tsd-kind-icon">RE_<wbr>MENTIONS</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="Client.html#RE_SPOILER" class="tsd-kind-icon">RE_<wbr>SPOILER</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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink