mirror of
https://github.com/stoatchat/javascript-client-sdk.git
synced 2026-07-22 13:05:38 -04:00
insertish
246 lines
19 KiB
HTML
246 lines
19 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>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">
|
|
<h1>revolt.js</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-panel tsd-typography">
|
|
<a href="#revoltjs" id="revoltjs" style="color: inherit; text-decoration: none;">
|
|
<h1>revolt.js</h1>
|
|
</a>
|
|
<p><img src="https://img.shields.io/npm/v/revolt.js" alt="revolt.js"> <img src="https://img.shields.io/npm/v/revolt-api?label=Revolt%20API" alt="revolt-api"></p>
|
|
<p><strong>revolt.js</strong> is a direct implementation of the entire Revolt API and provides a way to authenticate and start communicating with Revolt servers.</p>
|
|
<a href="#example-usage-javascript--es6" id="example-usage-javascript--es6" style="color: inherit; text-decoration: none;">
|
|
<h2>Example Usage (Javascript / ES6)</h2>
|
|
</a>
|
|
<pre><code class="language-javascript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">"revolt.js"</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #0000FF">let</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"ready"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> () </span><span style="color: #0000FF">=></span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">info</span><span style="color: #000000">(</span><span style="color: #A31515">`Logged in as </span><span style="color: #0000FF">${</span><span style="color: #001080">client</span><span style="color: #000000FF">.</span><span style="color: #001080">user</span><span style="color: #000000FF">.</span><span style="color: #001080">username</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">),</span>
|
|
<span style="color: #000000">);</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"message"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">content</span><span style="color: #000000"> === </span><span style="color: #A31515">"hello"</span><span style="color: #000000">) {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">channel</span><span style="color: #000000">.</span><span style="color: #795E26">sendMessage</span><span style="color: #000000">(</span><span style="color: #A31515">"world"</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000"> }</span>
|
|
<span style="color: #000000">});</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">loginBot</span><span style="color: #000000">(</span><span style="color: #A31515">".."</span><span style="color: #000000">);</span>
|
|
</code></pre>
|
|
<p>If you are using Node, you must specify <code>--experimental-specifier-resolution=node</code>.</p>
|
|
<p>For example, <code>node --experimental-specifier-resolution=node index.js</code>.</p>
|
|
<a href="#example-usage-commonjs" id="example-usage-commonjs" style="color: inherit; text-decoration: none;">
|
|
<h2>Example Usage (CommonJS)</h2>
|
|
</a>
|
|
<pre><code class="language-javascript"><span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">Client</span><span style="color: #000000"> } = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">"revolt.js"</span><span style="color: #000000">);</span>
|
|
|
|
<span style="color: #0000FF">let</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"ready"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> () </span><span style="color: #0000FF">=></span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">info</span><span style="color: #000000">(</span><span style="color: #A31515">`Logged in as </span><span style="color: #0000FF">${</span><span style="color: #001080">client</span><span style="color: #000000FF">.</span><span style="color: #001080">user</span><span style="color: #000000FF">.</span><span style="color: #001080">username</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">),</span>
|
|
<span style="color: #000000">);</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"message"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">content</span><span style="color: #000000"> === </span><span style="color: #A31515">"hello"</span><span style="color: #000000">) {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">channel</span><span style="color: #000000">.</span><span style="color: #795E26">sendMessage</span><span style="color: #000000">(</span><span style="color: #A31515">"world"</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000"> }</span>
|
|
<span style="color: #000000">});</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">loginBot</span><span style="color: #000000">(</span><span style="color: #A31515">".."</span><span style="color: #000000">);</span>
|
|
</code></pre>
|
|
<a href="#example-usage-typescript" id="example-usage-typescript" style="color: inherit; text-decoration: none;">
|
|
<h2>Example Usage (Typescript)</h2>
|
|
</a>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">"revolt.js"</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #0000FF">let</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">();</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"ready"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> () </span><span style="color: #0000FF">=></span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">info</span><span style="color: #000000">(</span><span style="color: #A31515">`Logged in as </span><span style="color: #0000FF">${</span><span style="color: #001080">client</span><span style="color: #000000FF">.</span><span style="color: #001080">user</span><span style="color: #000000">!</span><span style="color: #000000FF">.</span><span style="color: #001080">username</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">),</span>
|
|
<span style="color: #000000">);</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">"message"</span><span style="color: #000000">, </span><span style="color: #0000FF">async</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">content</span><span style="color: #000000"> === </span><span style="color: #A31515">"hello"</span><span style="color: #000000">) {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">message</span><span style="color: #000000">.</span><span style="color: #001080">channel</span><span style="color: #000000">!.</span><span style="color: #795E26">sendMessage</span><span style="color: #000000">(</span><span style="color: #A31515">"world"</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000"> }</span>
|
|
<span style="color: #000000">});</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">loginBot</span><span style="color: #000000">(</span><span style="color: #A31515">".."</span><span style="color: #000000">);</span>
|
|
</code></pre>
|
|
<a href="#mobx" id="mobx" style="color: inherit; text-decoration: none;">
|
|
<h2>MobX</h2>
|
|
</a>
|
|
<p>MobX is used behind the scenes so you can subscribe to any change as you normally would, e.g. with <code>mobx-react(-lite)</code> or mobx's utility functions.</p>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">autorun</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'mobx'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #000000">[..]</span>
|
|
|
|
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">once</span><span style="color: #000000">(</span><span style="color: #A31515">'ready'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #795E26">autorun</span><span style="color: #000000">(() </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Current username is </span><span style="color: #0000FF">${</span><span style="color: #001080">client</span><span style="color: #000000FF">.</span><span style="color: #001080">user</span><span style="color: #000000">!</span><span style="color: #000000FF">.</span><span style="color: #001080">username</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">);</span>
|
|
<span style="color: #000000"> });</span>
|
|
<span style="color: #000000">});</span>
|
|
</code></pre>
|
|
<a href="#revolt-api-types" id="revolt-api-types" style="color: inherit; text-decoration: none;">
|
|
<h2>Revolt API Types</h2>
|
|
</a>
|
|
<p>All <code>revolt-api</code> types are re-exported from this library under <code>API</code>.</p>
|
|
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">API</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'revolt.js'</span><span style="color: #000000">;</span>
|
|
|
|
<span style="color: #008000">// API.Channel;</span>
|
|
<span style="color: #008000">// API.[..];</span>
|
|
</code></pre>
|
|
</div>
|
|
</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=" 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_Emojis.html">maps/<wbr>Emojis</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">
|
|
</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> |