stoatchat/javascript-client-sdk
1
0
Fork 0
mirror of https://github.com/stoatchat/javascript-client-sdk.git synced 2026-07-21 12:35:21 -04:00
Code Issues 9 Packages Projects Releases 6 Wiki Activity
Files
decb8516bab09f556270ef9dee83a4d8bfc65e4f
javascript-client-sdk/interfaces/Client.ClientOptions.html
T

357 lines
16 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>ClientOptions | 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="../modules/Client.html">Client</a>
</li>
<li>
<a href="Client.ClientOptions.html">ClientOptions</a>
</li>
</ul>
<h1>Interface ClientOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Client options object</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ClientOptions</span>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#ackRateLimiter" class="tsd-kind-icon">ack<wbr>Rate<wbr>Limiter</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#apiURL" class="tsd-kind-icon">apiURL</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr>Reconnect</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#cache" class="tsd-kind-icon">cache</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#debug" class="tsd-kind-icon">debug</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#heartbeat" class="tsd-kind-icon">heartbeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#onPongTimeout" class="tsd-kind-icon">on<wbr>Pong<wbr>Timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#pongTimeout" class="tsd-kind-icon">pong<wbr>Timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Client.ClientOptions.html#unreads" class="tsd-kind-icon">unreads</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ackRateLimiter" class="tsd-anchor"></a>
<h3>ack<wbr>Rate<wbr>Limiter</h3>
<div class="tsd-signature tsd-kind-icon">ack<wbr>Rate<wbr>Limiter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L55">src/Client.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="apiURL" class="tsd-anchor"></a>
<h3>apiURL</h3>
<div class="tsd-signature tsd-kind-icon">apiURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L32">src/Client.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="autoReconnect" class="tsd-anchor"></a>
<h3>auto<wbr>Reconnect</h3>
<div class="tsd-signature tsd-kind-icon">auto<wbr>Reconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L39">src/Client.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="cache" class="tsd-anchor"></a>
<h3>cache</h3>
<div class="tsd-signature tsd-kind-icon">cache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L35">src/Client.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="debug" class="tsd-anchor"></a>
<h3>debug</h3>
<div class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L33">src/Client.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="heartbeat" class="tsd-anchor"></a>
<h3>heartbeat</h3>
<div class="tsd-signature tsd-kind-icon">heartbeat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L38">src/Client.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onPongTimeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Pong<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Pong<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EXIT&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;RECONNECT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L53">src/Client.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If <code>pongTimeout</code> is set, this decides what to do when
the timeout is triggered. Default is <code>RECONNECT</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="pongTimeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pong<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">pong<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L47">src/Client.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Automatically reconnect the client if no
<code>pong</code> is received after X seconds of sending a <code>ping</code>.
This is a temporary fix for an issue where the client
would randomly stop receiving websocket messages.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="unreads" class="tsd-anchor"></a>
<h3>unreads</h3>
<div class="tsd-signature tsd-kind-icon">unreads<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/52c7bfd/src/Client.ts#L36">src/Client.ts:36</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=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/Client.html">Client</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/config.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/globals.html">globals</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Bots.html">maps/<wbr>Bots</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Channels.html">maps/<wbr>Channels</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Collection.html">maps/<wbr>Collection</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Members.html">maps/<wbr>Members</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Messages.html">maps/<wbr>Messages</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Servers.html">maps/<wbr>Servers</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/maps_Users.html">maps/<wbr>Users</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/permissions_calculator.html">permissions/calculator</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/permissions_definitions.html">permissions/definitions</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/util_Unreads.html">util/<wbr>Unreads</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/util_null.html">util/null</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/websocket_client.html">websocket/client</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/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>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="Client.ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#ackRateLimiter" class="tsd-kind-icon">ack<wbr>Rate<wbr>Limiter</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#apiURL" class="tsd-kind-icon">apiURL</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#autoReconnect" class="tsd-kind-icon">auto<wbr>Reconnect</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#cache" class="tsd-kind-icon">cache</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#debug" class="tsd-kind-icon">debug</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#heartbeat" class="tsd-kind-icon">heartbeat</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#onPongTimeout" class="tsd-kind-icon">on<wbr>Pong<wbr>Timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#pongTimeout" class="tsd-kind-icon">pong<wbr>Timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="Client.ClientOptions.html#unreads" class="tsd-kind-icon">unreads</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/Client.html#FileArgs" class="tsd-kind-icon">File<wbr>Args</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/Client.html#RE_MENTIONS" class="tsd-kind-icon">RE_<wbr>MENTIONS</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/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-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
</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