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
ddaeec6afc7935ed3d3123e0366e643b99755913
javascript-client-sdk/modules.html
T

747 lines
67 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>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">
<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 tsd-is-external">
<h3>Namespaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-namespace tsd-is-external"><a href="modules/API.html" class="tsd-kind-icon">API</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/Channel.html" class="tsd-kind-icon">Channel</a></li>
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
<li class="tsd-kind-class"><a href="classes/Member.html" class="tsd-kind-icon">Member</a></li>
<li class="tsd-kind-class"><a href="classes/Message.html" class="tsd-kind-icon">Message</a></li>
<li class="tsd-kind-class"><a href="classes/Server.html" class="tsd-kind-icon">Server</a></li>
<li class="tsd-kind-class"><a href="classes/User.html" class="tsd-kind-icon">User</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/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"><a href="modules.html#ClientboundNotification" class="tsd-kind-icon">Clientbound<wbr>Notification</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#FileArgs" class="tsd-kind-icon">File<wbr>Args</a></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Nullable" class="tsd-kind-icon">Nullable</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#ReadyPacket" class="tsd-kind-icon">Ready<wbr>Packet</a></li>
<li class="tsd-kind-type-alias"><a href="modules.html#ServerboundNotification" class="tsd-kind-icon">Serverbound<wbr>Notification</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="modules.html#DEFAULT_PERMISSION" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION</a></li>
<li class="tsd-kind-variable"><a href="modules.html#DEFAULT_PERMISSION_DIRECT_MESSAGE" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>DIRECT_<wbr>MESSAGE</a></li>
<li class="tsd-kind-variable"><a href="modules.html#DEFAULT_PERMISSION_SAVED_MESSAGES" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SAVED_<wbr>MESSAGES</a></li>
<li class="tsd-kind-variable"><a href="modules.html#DEFAULT_PERMISSION_SERVER" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SERVER</a></li>
<li class="tsd-kind-variable"><a href="modules.html#DEFAULT_PERMISSION_VIEW_ONLY" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>VIEW_<wbr>ONLY</a></li>
<li class="tsd-kind-variable"><a href="modules.html#LIBRARY_VERSION" class="tsd-kind-icon">LIBRARY_<wbr>VERSION</a></li>
<li class="tsd-kind-variable"><a href="modules.html#Permission" class="tsd-kind-icon">Permission</a></li>
<li class="tsd-kind-variable"><a href="modules.html#RE_MENTIONS" class="tsd-kind-icon">RE_<wbr>MENTIONS</a></li>
<li class="tsd-kind-variable"><a href="modules.html#RE_SPOILER" class="tsd-kind-icon">RE_<wbr>SPOILER</a></li>
<li class="tsd-kind-variable"><a href="modules.html#U32_MAX" class="tsd-kind-icon">U32_<wbr>MAX</a></li>
<li class="tsd-kind-variable"><a href="modules.html#UserPermission" class="tsd-kind-icon">User<wbr>Permission</a></li>
<li class="tsd-kind-variable"><a href="modules.html#defaultConfig" class="tsd-kind-icon">default<wbr>Config</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="modules.html#calculatePermission" class="tsd-kind-icon">calculate<wbr>Permission</a></li>
<li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#toNullable" class="tsd-kind-icon">to<wbr>Nullable</a></li>
<li class="tsd-kind-function"><a href="modules.html#toNullableDate" class="tsd-kind-icon">to<wbr>Nullable<wbr>Date</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">
<a name="ClientboundNotification" class="tsd-anchor"></a>
<h3>Clientbound<wbr>Notification</h3>
<div class="tsd-signature tsd-kind-icon">Clientbound<wbr>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Bulk&quot;</span><span class="tsd-signature-symbol">; </span>v<span class="tsd-signature-symbol">: </span><a href="modules.html#ClientboundNotification" class="tsd-signature-type" data-tsd-kind="Type alias">ClientboundNotification</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Ping&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Pong&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Error&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">WebSocketError</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Authenticated&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><a href="modules.html#ReadyPacket" class="tsd-signature-type" data-tsd-kind="Type alias">ReadyPacket</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Message&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules/API.html#Message" class="tsd-signature-type" data-tsd-kind="Type alias">Message</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Message" class="tsd-signature-type" data-tsd-kind="Type alias">Message</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;MessageUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>append<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Message" class="tsd-signature-type" data-tsd-kind="Type alias">Message</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;embeds&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;MessageAppend&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;MessageDelete&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;BulkMessageDelete&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelCreate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules/API.html#Channel" class="tsd-signature-type" data-tsd-kind="Type alias">Channel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clear<span class="tsd-signature-symbol">?: </span><a href="modules/API.html#FieldsChannel" class="tsd-signature-type" data-tsd-kind="Type alias">FieldsChannel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Channel" class="tsd-signature-type" data-tsd-kind="Type alias">Channel</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelDelete&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelGroupJoin&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelGroupLeave&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelStartTyping&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelStopTyping&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>message_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ChannelAck&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channels<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Channel" class="tsd-signature-type" data-tsd-kind="Type alias">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>server<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Server" class="tsd-signature-type" data-tsd-kind="Type alias">Server</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerCreate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clear<span class="tsd-signature-symbol">?: </span><a href="modules/API.html#FieldsServer" class="tsd-signature-type" data-tsd-kind="Type alias">FieldsServer</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Server" class="tsd-signature-type" data-tsd-kind="Type alias">Server</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerDelete&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clear<span class="tsd-signature-symbol">?: </span><a href="modules/API.html#FieldsMember" class="tsd-signature-type" data-tsd-kind="Type alias">FieldsMember</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Member" class="tsd-signature-type" data-tsd-kind="Type alias">Member</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><a href="modules/API.html#MemberCompositeKey" class="tsd-signature-type" data-tsd-kind="Type alias">MemberCompositeKey</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerMemberUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerMemberJoin&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerMemberLeave&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#Role" class="tsd-signature-type" data-tsd-kind="Type alias">Role</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>role_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerRoleUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>role_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;ServerRoleDelete&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>clear<span class="tsd-signature-symbol">?: </span><a href="modules/API.html#FieldsUser" class="tsd-signature-type" data-tsd-kind="Type alias">FieldsUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="modules/API.html#User" class="tsd-signature-type" data-tsd-kind="Type alias">User</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;UserUpdate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="modules/API.html#RelationshipStatus" class="tsd-signature-type" data-tsd-kind="Type alias">RelationshipStatus</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;UserRelationship&quot;</span><span class="tsd-signature-symbol">; </span>user<span class="tsd-signature-symbol">: </span><a href="modules/API.html#User" class="tsd-signature-type" data-tsd-kind="Type alias">User</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>online<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;UserPresence&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;UserSettingsUpdate&quot;</span><span class="tsd-signature-symbol">; </span>update<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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/479713c/src/websocket/notifications.ts#L36">src/websocket/notifications.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<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/479713c/src/Client.ts#L100">src/Client.ts:100</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter">
<a name="Nullable" class="tsd-anchor"></a>
<h3>Nullable</h3>
<div class="tsd-signature tsd-kind-icon">Nullable&lt;T&gt;<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/util/null.ts#L1">src/util/null.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="ReadyPacket" class="tsd-anchor"></a>
<h3>Ready<wbr>Packet</h3>
<div class="tsd-signature tsd-kind-icon">Ready<wbr>Packet<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>channels<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Channel" class="tsd-signature-type" data-tsd-kind="Type alias">Channel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>members<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Member" class="tsd-signature-type" data-tsd-kind="Type alias">Member</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>servers<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Server" class="tsd-signature-type" data-tsd-kind="Type alias">Server</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Ready&quot;</span><span class="tsd-signature-symbol">; </span>users<span class="tsd-signature-symbol">: </span><a href="modules/API.html#User" class="tsd-signature-type" data-tsd-kind="Type alias">User</a><span class="tsd-signature-symbol">[]</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/479713c/src/websocket/notifications.ts#L28">src/websocket/notifications.ts:28</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>channels<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Channel" class="tsd-signature-type" data-tsd-kind="Type alias">Channel</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>members<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Member" class="tsd-signature-type" data-tsd-kind="Type alias">Member</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>servers<span class="tsd-signature-symbol">: </span><a href="modules/API.html#Server" class="tsd-signature-type" data-tsd-kind="Type alias">Server</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li class="tsd-parameter">
<h5>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Ready&quot;</span></h5>
</li>
<li class="tsd-parameter">
<h5>users<span class="tsd-signature-symbol">: </span><a href="modules/API.html#User" class="tsd-signature-type" data-tsd-kind="Type alias">User</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="ServerboundNotification" class="tsd-anchor"></a>
<h3>Serverbound<wbr>Notification</h3>
<div class="tsd-signature tsd-kind-icon">Serverbound<wbr>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Ping&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Pong&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Authenticate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules/API.html#Session" class="tsd-signature-type" data-tsd-kind="Type alias">Session</a><span class="tsd-signature-symbol">)</span><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>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Authenticate&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;BeginTyping&quot;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;EndTyping&quot;</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/479713c/src/websocket/notifications.ts#L20">src/websocket/notifications.ts:20</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="DEFAULT_PERMISSION" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PERMISSION</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PERMISSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L106">src/permissions/definitions.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default base permissions for channels</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="DEFAULT_PERMISSION_DIRECT_MESSAGE" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PERMISSION_<wbr>DIRECT_<wbr>MESSAGE</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>DIRECT_<wbr>MESSAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L123">src/permissions/definitions.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permissions in direct message channel</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="DEFAULT_PERMISSION_SAVED_MESSAGES" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PERMISSION_<wbr>SAVED_<wbr>MESSAGES</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SAVED_<wbr>MESSAGES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L118">src/permissions/definitions.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permissions in saved messages channel</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="DEFAULT_PERMISSION_SERVER" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PERMISSION_<wbr>SERVER</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SERVER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L129">src/permissions/definitions.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permissions in server text / voice channel</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="DEFAULT_PERMISSION_VIEW_ONLY" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>PERMISSION_<wbr>VIEW_<wbr>ONLY</h3>
<div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>VIEW_<wbr>ONLY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L100">src/permissions/definitions.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Default permissions if we can only view</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="LIBRARY_VERSION" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> LIBRARY_<wbr>VERSION</h3>
<div class="tsd-signature tsd-kind-icon">LIBRARY_<wbr>VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;6.0.0&quot;</span><span class="tsd-signature-symbol"> = &quot;6.0.0&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/config.ts#L1">src/config.ts:1</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="Permission" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Permission</h3>
<div class="tsd-signature tsd-kind-icon">Permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>AssignRoles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>BanMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ChangeAvatar<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ChangeNickname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>Connect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>DeafenMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>GrantAllSafe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>InviteOthers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>KickMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageChannel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageMessages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageNicknames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManagePermissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageRole<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageServer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ManageWebhooks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>Masquerade<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>MoveMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>MuteMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ReadMessageHistory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>RemoveAvatars<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>SendEmbeds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>SendMessage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>Speak<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>TimeoutMembers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>UploadFiles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>Video<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ViewChannel<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/permissions/definitions.ts#L14">src/permissions/definitions.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permission against Server / Channel</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>Assign<wbr>Roles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Ban<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Change<wbr>Avatar<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Change<wbr>Nickname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Connect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Deafen<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Grant<wbr>All<wbr>Safe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Invite<wbr>Others<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Kick<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Messages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Nicknames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Role<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Server<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Manage<wbr>Webhooks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Masquerade<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Move<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Mute<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Read<wbr>Message<wbr>History<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Remove<wbr>Avatars<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Send<wbr>Embeds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Send<wbr>Message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Speak<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Timeout<wbr>Members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Upload<wbr>Files<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Video<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>View<wbr>Channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<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/479713c/src/Client.ts#L93">src/Client.ts:93</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">
<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/479713c/src/Client.ts#L98">src/Client.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Regular expression for spoilers.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="U32_MAX" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> U32_<wbr>MAX</h3>
<div class="tsd-signature tsd-kind-icon">U32_<wbr>MAX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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/479713c/src/permissions/definitions.ts#L95">src/permissions/definitions.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maximum safe value</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="UserPermission" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> User<wbr>Permission</h3>
<div class="tsd-signature tsd-kind-icon">User<wbr>Permission<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>Access<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>Invite<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>SendMessage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ViewProfile<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/permissions/definitions.ts#L4">src/permissions/definitions.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Permission against User</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>Access<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Invite<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>Send<wbr>Message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>View<wbr>Profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="defaultConfig" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>ackRateLimiter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>apiURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>autoReconnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>cache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>heartbeat<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unreads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</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/479713c/src/config.ts#L3">src/config.ts:3</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>ack<wbr>Rate<wbr>Limiter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>apiURL<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>auto<wbr>Reconnect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>cache<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>debug<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>heartbeat<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5>unreads<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="calculatePermission" class="tsd-anchor"></a>
<h3>calculate<wbr>Permission</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">calculate<wbr>Permission<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="classes/Channel.html" class="tsd-signature-type" data-tsd-kind="Class">Channel</a><span class="tsd-signature-symbol"> | </span><a href="classes/Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>member<span class="tsd-signature-symbol">?: </span><a href="classes/Member.html" class="tsd-signature-type" data-tsd-kind="Class">Member</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/permissions/calculator.ts#L25">src/permissions/calculator.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculate permissions against a given object</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <a href="classes/Channel.html" class="tsd-signature-type" data-tsd-kind="Class">Channel</a><span class="tsd-signature-symbol"> | </span><a href="classes/Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h5>
<div class="tsd-comment tsd-typography">
<p>Target object to check permissions against</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>member<span class="tsd-signature-symbol">?: </span><a href="classes/Member.html" class="tsd-signature-type" data-tsd-kind="Class">Member</a><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Additional options to use when calculating</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> member<span class="tsd-signature-symbol">?: </span><a href="classes/Member.html" class="tsd-signature-type" data-tsd-kind="Class">Member</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Pretend to be another member</p>
</div>
</div>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-has-type-parameter">
<a name="toNullable" class="tsd-anchor"></a>
<h3>to<wbr>Nullable</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">to<wbr>Nullable&lt;T&gt;<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/util/null.ts#L2">src/util/null.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">T</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="toNullableDate" class="tsd-anchor"></a>
<h3>to<wbr>Nullable<wbr>Date</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">to<wbr>Nullable<wbr>Date<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>$date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/revoltchat/revolt.js/blob/479713c/src/util/null.ts#L11">src/util/null.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Backwards compatible convert potential Date value to Nullable<Date>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-symbol">{ </span>$date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
<div class="tsd-comment tsd-typography">
<p>ISO8601 Timestamp or BSON DateTime</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current ">
<a href="modules.html">Exports</a>
</li>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-namespace tsd-is-external">
<a href="modules/API.html">API</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="classes/Channel.html" class="tsd-kind-icon">Channel</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Member.html" class="tsd-kind-icon">Member</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Message.html" class="tsd-kind-icon">Message</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/Server.html" class="tsd-kind-icon">Server</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/User.html" class="tsd-kind-icon">User</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#ClientboundNotification" class="tsd-kind-icon">Clientbound<wbr>Notification</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#FileArgs" class="tsd-kind-icon">File<wbr>Args</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="modules.html#Nullable" class="tsd-kind-icon">Nullable</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#ReadyPacket" class="tsd-kind-icon">Ready<wbr>Packet</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="modules.html#ServerboundNotification" class="tsd-kind-icon">Serverbound<wbr>Notification</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#DEFAULT_PERMISSION" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#DEFAULT_PERMISSION_DIRECT_MESSAGE" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>DIRECT_<wbr>MESSAGE</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#DEFAULT_PERMISSION_SAVED_MESSAGES" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SAVED_<wbr>MESSAGES</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#DEFAULT_PERMISSION_SERVER" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>SERVER</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#DEFAULT_PERMISSION_VIEW_ONLY" class="tsd-kind-icon">DEFAULT_<wbr>PERMISSION_<wbr>VIEW_<wbr>ONLY</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#LIBRARY_VERSION" class="tsd-kind-icon">LIBRARY_<wbr>VERSION</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#Permission" class="tsd-kind-icon">Permission</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#RE_MENTIONS" class="tsd-kind-icon">RE_<wbr>MENTIONS</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#RE_SPOILER" class="tsd-kind-icon">RE_<wbr>SPOILER</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#U32_MAX" class="tsd-kind-icon">U32_<wbr>MAX</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#UserPermission" class="tsd-kind-icon">User<wbr>Permission</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#defaultConfig" class="tsd-kind-icon">default<wbr>Config</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#calculatePermission" class="tsd-kind-icon">calculate<wbr>Permission</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="modules.html#toNullable" class="tsd-kind-icon">to<wbr>Nullable</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#toNullableDate" class="tsd-kind-icon">to<wbr>Nullable<wbr>Date</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-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>
</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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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