deploy: eec73e9749
This commit is contained in:
778
shared/ws.ts/index.html
Normal file
778
shared/ws.ts/index.html
Normal file
@@ -0,0 +1,778 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>shared/ws.ts - gerbeur documentation</title>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="doc-current-file" content="">
|
||||
<link rel="stylesheet" href="../../styles.css">
|
||||
<link rel="stylesheet" href="../../page.css">
|
||||
<link id="ddocResetStylesheet" rel="stylesheet" href="../../reset.css"><link href="../../comrak.css" rel="stylesheet" /><link href="../../prism.css" rel="stylesheet" /><script src="../../prism.js"></script><script src="../../script.js" defer></script>
|
||||
<script src="../../darkmode_toggle.js"></script><script src="../../search_index.js" defer></script>
|
||||
<script src="../../fuse.js" defer></script>
|
||||
<script src="../../search.js" defer></script></head>
|
||||
<body>
|
||||
<div class="ddoc">
|
||||
<div><nav id="topnav">
|
||||
<div class="h-full">
|
||||
<div class="flex items-center"><ul class="breadcrumbs">
|
||||
<li>
|
||||
<a href="../../" class="contextLink">gerbeur</a>
|
||||
</li><span class="text-black dark:text-white"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 16 16"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M5.76748 11.8159C5.5378 11.577 5.54525 11.1972 5.78411 10.9675L8.93431 8L5.78411 5.0325C5.54525 4.80282 5.5378 4.423 5.76748 4.18413C5.99715 3.94527 6.37698 3.93782 6.61584 4.1675L10.2158 7.5675C10.3335 7.68062 10.4 7.83679 10.4 8C10.4 8.16321 10.3335 8.31938 10.2158 8.4325L6.61584 11.8325C6.37698 12.0622 5.99715 12.0547 5.76748 11.8159Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
</span>shared/ws.ts</ul>
|
||||
</div>
|
||||
|
||||
<div class="flex items-center gap-2">
|
||||
<button id="theme-toggle" type="button" aria-label="Toggle dark mode" style="display: none;"><svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path
|
||||
d="M12 1.992a10 10 0 1 0 9.236 13.838c.341 -.82 -.476 -1.644 -1.298 -1.31a6.5 6.5 0 0 1 -6.864 -10.787l.077 -.08c.551 -.63 .113 -1.653 -.758 -1.653h-.266l-.068 -.006l-.06 -.002z"
|
||||
/>
|
||||
</svg>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
class="hidden"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path
|
||||
d="M12 19a1 1 0 0 1 .993 .883l.007 .117v1a1 1 0 0 1 -1.993 .117l-.007 -.117v-1a1 1 0 0 1 1 -1z"
|
||||
/>
|
||||
<path
|
||||
d="M18.313 16.91l.094 .083l.7 .7a1 1 0 0 1 -1.32 1.497l-.094 -.083l-.7 -.7a1 1 0 0 1 1.218 -1.567l.102 .07z"
|
||||
/>
|
||||
<path
|
||||
d="M7.007 16.993a1 1 0 0 1 .083 1.32l-.083 .094l-.7 .7a1 1 0 0 1 -1.497 -1.32l.083 -.094l.7 -.7a1 1 0 0 1 1.414 0z"
|
||||
/>
|
||||
<path
|
||||
d="M4 11a1 1 0 0 1 .117 1.993l-.117 .007h-1a1 1 0 0 1 -.117 -1.993l.117 -.007h1z"
|
||||
/>
|
||||
<path
|
||||
d="M21 11a1 1 0 0 1 .117 1.993l-.117 .007h-1a1 1 0 0 1 -.117 -1.993l.117 -.007h1z"
|
||||
/>
|
||||
<path
|
||||
d="M6.213 4.81l.094 .083l.7 .7a1 1 0 0 1 -1.32 1.497l-.094 -.083l-.7 -.7a1 1 0 0 1 1.217 -1.567l.102 .07z"
|
||||
/>
|
||||
<path
|
||||
d="M19.107 4.893a1 1 0 0 1 .083 1.32l-.083 .094l-.7 .7a1 1 0 0 1 -1.497 -1.32l.083 -.094l.7 -.7a1 1 0 0 1 1.414 0z"
|
||||
/>
|
||||
<path
|
||||
d="M12 2a1 1 0 0 1 .993 .883l.007 .117v1a1 1 0 0 1 -1.993 .117l-.007 -.117v-1a1 1 0 0 1 1 -1z"
|
||||
/>
|
||||
<path
|
||||
d="M12 7a5 5 0 1 1 -4.995 5.217l-.005 -.217l.005 -.217a5 5 0 0 1 4.995 -4.783z"
|
||||
/>
|
||||
</svg>
|
||||
</button>
|
||||
|
||||
<input
|
||||
type="text"
|
||||
id="searchbar"
|
||||
style="display: none;"
|
||||
class="py-2 px-2.5 mx-1 rounded text-sm border border-gray-300 bg-transparent dark:bg-gray-800 dark:border-gray-700"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="searchResults"></div><div id="content">
|
||||
<main><section>
|
||||
<div class="space-y-2 flex-1"><div class="space-y-7" id="module_doc"><div class="markdown"><p>Live updates, votes, likes and the chat travel over one WebSocket between
|
||||
<code>WSProvider</code> in the client and <code>routes/ws.ts</code> in the server. This module
|
||||
types its messages, JSON objects told apart by <code>type</code>.</p>
|
||||
<p>The server's messages go out from <code>services/ws-service.ts</code>, and <code>WSProvider</code>
|
||||
handles them. Their Dates arrive as strings, so the client reads them as
|
||||
<code>Wire<ServerToClientMessage></code> and deserializes what it keeps.</p>
|
||||
</div><section class="section" id="shared/ws_ts_interfaces"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#shared/ws_ts_interfaces" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Interfaces</h2></div><div class="namespaceSection"><div id="namespace_categorieschangedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CategoriesChangedMessage.html" title="CategoriesChangedMessage">
|
||||
<span>CategoriesChangedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the category service to every socket after a category is created,
|
||||
edited or deleted. <code>CategoriesProvider</code> fetches the categories again.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CategoriesChangedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"categories_changed"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatdeletemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatDeleteMessage.html" title="ChatDeleteMessage">
|
||||
<span>ChatDeleteMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the user deletes a chat message, as
|
||||
<a href="../.././shared/ws.ts/~/ChatEditMessage.html">ChatEditMessage</a>. The server broadcasts
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageDeletedMessage.html">ChatMessageDeletedMessage</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatDeleteMessage.html#property_id">
|
||||
<span>id</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatDeleteMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_delete"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chateditmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatEditMessage.html" title="ChatEditMessage">
|
||||
<span>ChatEditMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the user edits a chat message, their own or, with
|
||||
<code>chat:moderate</code>, anyone's. The server broadcasts
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageUpdatedMessage.html">ChatMessageUpdatedMessage</a>, or answers a chat <a href="../.././shared/ws.ts/~/ErrorMessage.html">ErrorMessage</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatEditMessage.html#property_body">
|
||||
<span>body</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatEditMessage.html#property_id">
|
||||
<span>id</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatEditMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_edit"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatfocusmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatFocusMessage.html" title="ChatFocusMessage">
|
||||
<span>ChatFocusMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the chatbox opens or closes, when the tab is
|
||||
hidden or shown, and after each <code>welcome</code>. The server notifies no one of a
|
||||
chat mention while one of their sockets says <code>open</code>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatFocusMessage.html#property_open">
|
||||
<span>open</span><span>: <span class="td-kw">boolean</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>True only while the chatbox is open in a visible tab.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatFocusMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_focus"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatmessagedeletedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageDeletedMessage.html" title="ChatMessageDeletedMessage">
|
||||
<span>ChatMessageDeletedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every signed-in socket when a chat message is deleted.
|
||||
The client also keeps the id, to show the replies to it as replies to a
|
||||
deleted message.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageDeletedMessage.html#property_id">
|
||||
<span>id</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageDeletedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_message_deleted"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatmessagemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageMessage.html" title="ChatMessageMessage">
|
||||
<span>ChatMessageMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every signed-in socket, the sender's included, when a
|
||||
chat message is posted. <code>WSProvider</code> adds it to the live chat, counts it
|
||||
unread unless the user is reading the chat, and may chime.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageMessage.html#property_message">
|
||||
<span>message</span><span>: <span class="td-ref">ChatMessage</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageMessage.html#property_nonce">
|
||||
<span>nonce</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The sender's <a href="../.././shared/ws.ts/~/ChatSendMessage.html">ChatSendMessage</a> nonce, by which its client swaps the
|
||||
pending copy for this one.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_message"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatmessageupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageUpdatedMessage.html" title="ChatMessageUpdatedMessage">
|
||||
<span>ChatMessageUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every signed-in socket when a chat message is edited.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageUpdatedMessage.html#property_message">
|
||||
<span>message</span><span>: <span class="td-ref">ChatMessage</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_message_updated"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatreadmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatReadMessage.html" title="ChatReadMessage">
|
||||
<span>ChatReadMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code>, at most once a second, as the user reads the chat. The
|
||||
server moves their read marker to <code>at</code>, a message's ISO <code>createdAt</code>, and
|
||||
answers <a href="../.././shared/ws.ts/~/ChatReadUpdateMessage.html">ChatReadUpdateMessage</a>. It drops the message silently when it
|
||||
is malformed or over its rate limit.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatReadMessage.html#property_at">
|
||||
<span>at</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatReadMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_read"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chatreadupdatemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatReadUpdateMessage.html" title="ChatReadUpdateMessage">
|
||||
<span>ChatReadUpdateMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every socket of a user after their
|
||||
<a href="../.././shared/ws.ts/~/ChatReadMessage.html">ChatReadMessage</a>, so that all their tabs and devices update the chat's
|
||||
badge.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatReadUpdateMessage.html#property_readat">
|
||||
<span>readAt</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatReadUpdateMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_read_update"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatReadUpdateMessage.html#property_unread">
|
||||
<span>unread</span><span>: <span class="td-kw">number</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Counts only the messages of other users after <code>readAt</code>.</p>
|
||||
</div></div></li></ul></div>
|
||||
</div><div id="namespace_chatsendmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatSendMessage.html" title="ChatSendMessage">
|
||||
<span>ChatSendMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the user posts in the chatbox, which shows the
|
||||
message as pending meanwhile. The server broadcasts it as
|
||||
<a href="../.././shared/ws.ts/~/ChatMessageMessage.html">ChatMessageMessage</a>, or answers a chat <a href="../.././shared/ws.ts/~/ErrorMessage.html">ErrorMessage</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatSendMessage.html#property_body">
|
||||
<span>body</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatSendMessage.html#property_nonce">
|
||||
<span>nonce</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Chosen by the client, and echoed on the broadcast or the error, so that
|
||||
it can match the outcome to its pending message. Ignored if longer than
|
||||
64 characters.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatSendMessage.html#property_replytoid">
|
||||
<span>replyToId</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Ignored if longer than 64 characters or naming no message.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatSendMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_send"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chattypingmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingMessage.html" title="ChatTypingMessage">
|
||||
<span>ChatTypingMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the chatbox while the user types, every 3 s, and once they pause.
|
||||
The server answers every signed-in socket with
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingUpdateMessage.html">ChatTypingUpdateMessage</a> when the user starts or stops, and forgets a
|
||||
typer it hasn't heard from in 6 s.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_typing"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingMessage.html#property_typing">
|
||||
<span>typing</span><span>: <span class="td-kw">boolean</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_chattypingupdatemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingUpdateMessage.html" title="ChatTypingUpdateMessage">
|
||||
<span>ChatTypingUpdateMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every signed-in socket when a user starts or stops
|
||||
typing in the chat, with everyone typing. The chatbox shows their avatars.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingUpdateMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"chat_typing_update"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ChatTypingUpdateMessage.html#property_users">
|
||||
<span>users</span><span>: <span class="td-ref">OnlineUser</span>[]</span></a></li></ul></div>
|
||||
</div><div id="namespace_commentcreatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentCreatedMessage.html" title="CommentCreatedMessage">
|
||||
<span>CommentCreatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a comment is posted, to every socket if its dump is
|
||||
public, else to the dump's poster's. <code>WSProvider</code> passes it on to the dump's
|
||||
page and the dump lists as a <code>comment</code> event, as it does the two messages
|
||||
below.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentCreatedMessage.html#property_comment">
|
||||
<span>comment</span><span>: <span class="td-ref">Comment</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentCreatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_created"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentdeletedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentDeletedMessage.html" title="CommentDeletedMessage">
|
||||
<span>CommentDeletedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a comment is deleted, as when one is posted.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentDeletedMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentDeletedMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Lets a dump's page ignore the comments of other dumps.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentDeletedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_deleted"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentlikeackmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html" title="CommentLikeAckMessage">
|
||||
<span>CommentLikeAckMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to the socket that liked or unliked a comment, as
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html">VoteAckMessage</a> is for a vote.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html#property_action">
|
||||
<span>action</span><span>: <span><span class="td-str">"cast"</span><span class="td-op"> | </span><span class="td-str">"remove"</span></span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html#property_likecount">
|
||||
<span>likeCount</span><span>: <span class="td-kw">number</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_like_ack"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentlikecastmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeCastMessage.html" title="CommentLikeCastMessage">
|
||||
<span>CommentLikeCastMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the user likes a comment, and handled as
|
||||
<a href="../.././shared/ws.ts/~/VoteCastMessage.html">VoteCastMessage</a> is, with <a href="../.././shared/ws.ts/~/CommentLikeAckMessage.html">CommentLikeAckMessage</a> for the ack.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeCastMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeCastMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_like_cast"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentlikeremovemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeRemoveMessage.html" title="CommentLikeRemoveMessage">
|
||||
<span>CommentLikeRemoveMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> to withdraw a like, as <a href="../.././shared/ws.ts/~/CommentLikeCastMessage.html">CommentLikeCastMessage</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeRemoveMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikeRemoveMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_like_remove"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentlikesupdatemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html" title="CommentLikesUpdateMessage">
|
||||
<span>CommentLikesUpdateMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server after a like, as <a href="../.././shared/ws.ts/~/VotesUpdateMessage.html">VotesUpdateMessage</a> is after a
|
||||
vote: to the dump's poster alone when the comment is on a private dump.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html#property_action">
|
||||
<span>action</span><span>: <span><span class="td-str">"cast"</span><span class="td-op"> | </span><span class="td-str">"remove"</span></span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html#property_likecount">
|
||||
<span>likeCount</span><span>: <span class="td-kw">number</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html#property_likerid">
|
||||
<span>likerId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentLikesUpdateMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_likes_update"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_commentupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/CommentUpdatedMessage.html" title="CommentUpdatedMessage">
|
||||
<span>CommentUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a comment is edited, as when one is posted.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentUpdatedMessage.html#property_comment">
|
||||
<span>comment</span><span>: <span class="td-ref">Comment</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/CommentUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"comment_updated"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_dumpcreatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/DumpCreatedMessage.html" title="DumpCreatedMessage">
|
||||
<span>DumpCreatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a dump is posted, to every socket if it is public
|
||||
and to its poster's alone if it is private. It also goes to everyone but the
|
||||
poster when a private dump goes public, since to them it is new.
|
||||
<code>WSProvider</code> puts it at the top of its recent dumps.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpCreatedMessage.html#property_dump">
|
||||
<span>dump</span><span>: <span class="td-ref">Dump</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpCreatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"dump_created"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_dumpdeletedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/DumpDeletedMessage.html" title="DumpDeletedMessage">
|
||||
<span>DumpDeletedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a dump is deleted, to every socket if it was public
|
||||
and to its poster's alone if it was private. It also goes to everyone but
|
||||
the poster when a public dump goes private. <code>WSProvider</code> drops it from every
|
||||
list.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpDeletedMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpDeletedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"dump_deleted"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_dumprelatedchangedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/DumpRelatedChangedMessage.html" title="DumpRelatedChangedMessage">
|
||||
<span>DumpRelatedChangedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when the dumps related to some dumps changed: a note or
|
||||
a comment gained or lost a link to a dump, or a dump that has such links
|
||||
turned public. It goes to the sockets whose user may see both ends of a
|
||||
link. The <code>Dump</code> page showing one of <code>dumpIds</code> fetches its related dumps
|
||||
again.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpRelatedChangedMessage.html#property_dumpids">
|
||||
<span>dumpIds</span><span>: <span class="td-kw">string</span>[]</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>The dump whose links changed, then the dumps at their other end, without
|
||||
those this socket's user may not see.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpRelatedChangedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"dump_related_changed"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_dumpupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/DumpUpdatedMessage.html" title="DumpUpdatedMessage">
|
||||
<span>DumpUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a dump changes, to every socket if it is public and
|
||||
to its poster's alone if it is private, as when it has just gone private.
|
||||
<code>WSProvider</code> refreshes it in place, without moving it up the feeds.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpUpdatedMessage.html#property_dump">
|
||||
<span>dump</span><span>: <span class="td-ref">Dump</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/DumpUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"dump_updated"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_errormessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html" title="ErrorMessage">
|
||||
<span>ErrorMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to the socket whose message failed. With <code>dumpId</code> or
|
||||
<code>commentId</code>, <code>WSProvider</code> undoes that optimistic vote or like at once rather
|
||||
than after its 5 s timeout. With <code>scope</code>, the chatbox shows it, on the
|
||||
pending message <code>nonce</code> names or as a notice. Any other error is ignored.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_action">
|
||||
<span>action</span><span>: <span><span class="td-str">"cast"</span><span class="td-op"> | </span><span class="td-str">"remove"</span></span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_commentid">
|
||||
<span>commentId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_message">
|
||||
<span>message</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>In English: the chatbox shows it untranslated.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_nonce">
|
||||
<span>nonce</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Set only on the failure of a <a href="../.././shared/ws.ts/~/ChatSendMessage.html">ChatSendMessage</a> that had one.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_scope">
|
||||
<span>scope</span><span>: <span class="td-str">"chat"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/ErrorMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"error"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_followschangedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/FollowsChangedMessage.html" title="FollowsChangedMessage">
|
||||
<span>FollowsChangedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every socket of a user who followed or unfollowed a
|
||||
user or a playlist, so that <code>FollowProvider</code> in their other tabs refetches
|
||||
the follow status.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/FollowsChangedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"follows_changed"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_notificationcreatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/NotificationCreatedMessage.html" title="NotificationCreatedMessage">
|
||||
<span>NotificationCreatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the notification service to every socket of the notified user.
|
||||
<code>WSProvider</code> bumps the unread count and chimes.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/NotificationCreatedMessage.html#property_notification">
|
||||
<span>notification</span><span>: <span class="td-ref">Notification</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/NotificationCreatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"notification_created"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_notificationsreadmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/NotificationsReadMessage.html" title="NotificationsReadMessage">
|
||||
<span>NotificationsReadMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the notification service to every socket of a user who opened their
|
||||
notifications, which marks them all read. <code>WSProvider</code> zeroes the bell's
|
||||
count, in the other tabs and devices too.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/NotificationsReadMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"notifications_read"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_onlineuser" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/OnlineUser.html" title="OnlineUser">
|
||||
<span>OnlineUser</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server in <a href="../.././shared/ws.ts/~/WelcomeMessage.html">WelcomeMessage</a>,
|
||||
<a href="../.././shared/ws.ts/~/PresenceUpdateMessage.html">PresenceUpdateMessage</a> and <a href="../.././shared/ws.ts/~/ChatTypingUpdateMessage.html">ChatTypingUpdateMessage</a>, once per
|
||||
signed-in user whatever their number of sockets.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/OnlineUser.html#property_avatarversion">
|
||||
<span>avatarVersion</span><span>: <span class="td-kw">number</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Set when the avatar changed while the user was connected, for the client
|
||||
to append to the avatar's URL so it doesn't show the cached one.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/OnlineUser.html#property_hasavatar">
|
||||
<span>hasAvatar</span><span>: <span class="td-kw">boolean</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/OnlineUser.html#property_userid">
|
||||
<span>userId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/OnlineUser.html#property_username">
|
||||
<span>username</span><span>: <span class="td-kw">string</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_pingmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PingMessage.html" title="PingMessage">
|
||||
<span>PingMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every socket every 30 s. <code>WSProvider</code> answers
|
||||
<a href="../.././shared/ws.ts/~/PongMessage.html">PongMessage</a>, and a socket that missed the previous ping is closed.
|
||||
The server also answers a client's ping, though the client never sends one.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PingMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"ping"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_playlistcreatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PlaylistCreatedMessage.html" title="PlaylistCreatedMessage">
|
||||
<span>PlaylistCreatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a playlist is created, to every socket if it is
|
||||
public, else to its owner's. It also goes to everyone but the owner when a
|
||||
private playlist goes public, since to them it is new. <code>WSProvider</code> passes
|
||||
it on to the playlist pages as a <code>playlist</code> event, as it does the three
|
||||
messages below.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistCreatedMessage.html#property_playlist">
|
||||
<span>playlist</span><span>: <span class="td-ref">Playlist</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistCreatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"playlist_created"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_playlistdeletedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDeletedMessage.html" title="PlaylistDeletedMessage">
|
||||
<span>PlaylistDeletedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a playlist is deleted, to those who could see it. It
|
||||
also goes to everyone but the owner when a public playlist goes private.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDeletedMessage.html#property_playlistid">
|
||||
<span>playlistId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDeletedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"playlist_deleted"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDeletedMessage.html#property_userid">
|
||||
<span>userId</span><span>: <span class="td-kw">string</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_playlistdumpsupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDumpsUpdatedMessage.html" title="PlaylistDumpsUpdatedMessage">
|
||||
<span>PlaylistDumpsUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when dumps are added to, removed from or reordered in a
|
||||
playlist, to those who can see it, and when one of its dumps is deleted or
|
||||
changes visibility, which changes what its viewers see of it.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDumpsUpdatedMessage.html#property_dumpids">
|
||||
<span>dumpIds</span><span>: <span class="td-kw">string</span>[]</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Only the dumps this socket's user may see, in order: another user's
|
||||
private dump is left out.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDumpsUpdatedMessage.html#property_lastdumpat">
|
||||
<span>lastDumpAt</span><span>: <span class="td-ref">Date</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>When the latest of them was added, the playlist's <code>lastDumpAt</code> for this
|
||||
socket's user. It is missing when <code>dumpIds</code> is empty.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDumpsUpdatedMessage.html#property_playlistid">
|
||||
<span>playlistId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistDumpsUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"playlist_dumps_updated"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_playlistupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PlaylistUpdatedMessage.html" title="PlaylistUpdatedMessage">
|
||||
<span>PlaylistUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server when a playlist changes, to every socket if it is public,
|
||||
else to its owner's, as when it has just gone private. Its <code>dumpCount</code> and
|
||||
<code>lastDumpAt</code> are the socket's user's, as in <code>playlist_created</code>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistUpdatedMessage.html#property_playlist">
|
||||
<span>playlist</span><span>: <span class="td-ref">Playlist</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PlaylistUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"playlist_updated"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_pongmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PongMessage.html" title="PongMessage">
|
||||
<span>PongMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent in answer to a <a href="../.././shared/ws.ts/~/PingMessage.html">PingMessage</a>. The server records the client's to
|
||||
keep its socket open, and the client ignores the server's.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PongMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"pong"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_presenceupdatemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/PresenceUpdateMessage.html" title="PresenceUpdateMessage">
|
||||
<span>PresenceUpdateMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every socket when a socket opens or closes, and when
|
||||
a connected user's avatar changes.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/PresenceUpdateMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"presence_update"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/PresenceUpdateMessage.html#property_users">
|
||||
<span>users</span><span>: <span class="td-ref">OnlineUser</span>[]</span></a></li></ul></div>
|
||||
</div><div id="namespace_userupdatedmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/UserUpdatedMessage.html" title="UserUpdatedMessage">
|
||||
<span>UserUpdatedMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to every socket after a profile edit, a rename, a role
|
||||
change or an avatar upload. <code>WSProvider</code> refreshes the user's avatar
|
||||
wherever it shows, and passes it on as a <code>user</code> event, which updates their
|
||||
profile and their name on the lists.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/UserUpdatedMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"user_updated"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/UserUpdatedMessage.html#property_user">
|
||||
<span>user</span><span>: <span class="td-ref">PublicUser</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_voteackmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html" title="VoteAckMessage">
|
||||
<span>VoteAckMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to the socket that sent a <a href="../.././shared/ws.ts/~/VoteCastMessage.html">VoteCastMessage</a> or
|
||||
<a href="../.././shared/ws.ts/~/VoteRemoveMessage.html">VoteRemoveMessage</a>, once the vote is stored. <code>WSProvider</code> confirms
|
||||
its optimistic vote with it.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html#property_action">
|
||||
<span>action</span><span>: <span><span class="td-str">"cast"</span><span class="td-op"> | </span><span class="td-str">"remove"</span></span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"vote_ack"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteAckMessage.html#property_votecount">
|
||||
<span>voteCount</span><span>: <span class="td-kw">number</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_votecastmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/VoteCastMessage.html" title="VoteCastMessage">
|
||||
<span>VoteCastMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> when the user upvotes a dump, after it has shown the
|
||||
vote. The server answers <a href="../.././shared/ws.ts/~/VoteAckMessage.html">VoteAckMessage</a>, or an <a href="../.././shared/ws.ts/~/ErrorMessage.html">ErrorMessage</a>
|
||||
naming the dump, on which the client undoes the vote, as it does when
|
||||
neither comes within 5 s.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteCastMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteCastMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"vote_cast"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_voteremovemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/VoteRemoveMessage.html" title="VoteRemoveMessage">
|
||||
<span>VoteRemoveMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code> to withdraw an upvote, as <a href="../.././shared/ws.ts/~/VoteCastMessage.html">VoteCastMessage</a>.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteRemoveMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VoteRemoveMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"vote_remove"</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_votesupdatemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html" title="VotesUpdateMessage">
|
||||
<span>VotesUpdateMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server after a vote, to every socket, or to the poster's alone
|
||||
for a private dump. <code>WSProvider</code> updates the count, and when <code>voterId</code> is
|
||||
the user, it updates their votes too, so their other tabs follow.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html#property_action">
|
||||
<span>action</span><span>: <span><span class="td-str">"cast"</span><span class="td-op"> | </span><span class="td-str">"remove"</span></span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html#property_dumpid">
|
||||
<span>dumpId</span><span>: <span class="td-kw">string</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"votes_update"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html#property_votecount">
|
||||
<span>voteCount</span><span>: <span class="td-kw">number</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/VotesUpdateMessage.html#property_voterid">
|
||||
<span>voterId</span><span>: <span class="td-kw">string</span></span></a></li></ul></div>
|
||||
</div><div id="namespace_welcomemessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html" title="WelcomeMessage">
|
||||
<span>WelcomeMessage</span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by the server to a socket once it opens, just after the
|
||||
<a href="../.././shared/ws.ts/~/PresenceUpdateMessage.html">PresenceUpdateMessage</a> that announces it. <code>WSProvider</code> replaces its
|
||||
state with this one, dropping its pending votes and likes. After a
|
||||
reconnect, it also bumps <code>connectionEpoch</code>, so that pages refetch what they
|
||||
missed. The per-user fields are empty or zero on an anonymous socket.</p>
|
||||
</div></div><ul class="namespaceItemContentSubItems"><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_chatreadat">
|
||||
<span>chatReadAt</span><span>: <span class="td-kw">string</span></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Absent on an anonymous socket.</p>
|
||||
</div></div></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_mycommentlikes">
|
||||
<span>myCommentLikes</span><span>: <span class="td-kw">string</span>[]</span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_myvotes">
|
||||
<span>myVotes</span><span>: <span class="td-kw">string</span>[]</span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_type">
|
||||
<span>type</span><span>: <span class="td-str">"welcome"</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_unreadchatcount">
|
||||
<span>unreadChatCount</span><span>: <span class="td-kw">number</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_unreadnotificationcount">
|
||||
<span>unreadNotificationCount</span><span>: <span class="td-kw">number</span></span></a></li><li>
|
||||
<a href="../.././shared/ws.ts/~/WelcomeMessage.html#property_users">
|
||||
<span>users</span><span>: <span class="td-ref">OnlineUser</span>[]</span></a></li></ul></div>
|
||||
</div></div>
|
||||
</section>
|
||||
<section class="section" id="shared/ws_ts_type-aliases"><div>
|
||||
<h2 class="anchorable mb-1"><a href="#shared/ws_ts_type-aliases" class="anchor" aria-label="Anchor" tabIndex="-1"><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 14 14"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<g clip-path="url(#clip0_1081_1237)">
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M6.80328 2.8656C6.68736 2.99 6.62425 3.15454 6.62725 3.32456C6.63025 3.49457 6.69913 3.65678 6.81936 3.77702C6.9396 3.89725 7.10181 3.96613 7.27182 3.96913C7.44184 3.97213 7.60638 3.90902 7.73078 3.7931L8.82453 2.69935C8.98712 2.53676 9.18015 2.40778 9.39259 2.31978C9.60503 2.23179 9.83272 2.1865 10.0627 2.1865C10.2926 2.1865 10.5203 2.23179 10.7327 2.31978C10.9452 2.40778 11.1382 2.53676 11.3008 2.69935C11.4634 2.86194 11.5923 3.05497 11.6803 3.2674C11.7683 3.47984 11.8136 3.70753 11.8136 3.93747C11.8136 4.16741 11.7683 4.3951 11.6803 4.60754C11.5923 4.81998 11.4634 5.013 11.3008 5.1756L9.11328 7.3631C8.95075 7.52581 8.75775 7.65488 8.5453 7.74295C8.33285 7.83102 8.10513 7.87635 7.87516 7.87635C7.64518 7.87635 7.41746 7.83102 7.20501 7.74295C6.99256 7.65488 6.79956 7.52581 6.63703 7.3631C6.51263 7.24718 6.34809 7.18407 6.17807 7.18707C6.00806 7.19007 5.84585 7.25894 5.72561 7.37918C5.60538 7.49942 5.5365 7.66163 5.5335 7.83164C5.5305 8.00165 5.59361 8.1662 5.70953 8.2906C5.99391 8.57501 6.33154 8.80062 6.70312 8.95455C7.0747 9.10847 7.47296 9.18769 7.87516 9.18769C8.27736 9.18769 8.67562 9.10847 9.0472 8.95455C9.41878 8.80062 9.7564 8.57501 10.0408 8.2906L12.2283 6.1031C12.8026 5.52874 13.1253 4.74974 13.1253 3.93747C13.1253 3.12521 12.8026 2.34621 12.2283 1.77185C11.6539 1.19749 10.8749 0.874817 10.0627 0.874817C9.25039 0.874817 8.47139 1.19749 7.89703 1.77185L6.80328 2.8656ZM2.69953 11.3006C2.53682 11.1381 2.40774 10.9451 2.31968 10.7326C2.23161 10.5202 2.18628 10.2924 2.18628 10.0625C2.18628 9.8325 2.23161 9.60477 2.31968 9.39233C2.40774 9.17988 2.53682 8.98688 2.69953 8.82435L4.88703 6.63685C5.04956 6.47414 5.24256 6.34506 5.45501 6.25699C5.66746 6.16893 5.89518 6.1236 6.12516 6.1236C6.35513 6.1236 6.58285 6.16893 6.7953 6.25699C7.00775 6.34506 7.20075 6.47414 7.36328 6.63685C7.48768 6.75277 7.65223 6.81588 7.82224 6.81288C7.99225 6.80988 8.15446 6.741 8.2747 6.62077C8.39494 6.50053 8.46381 6.33832 8.46681 6.1683C8.46981 5.99829 8.4067 5.83375 8.29078 5.70935C8.0064 5.42494 7.66878 5.19933 7.2972 5.0454C6.92562 4.89148 6.52736 4.81225 6.12516 4.81225C5.72296 4.81225 5.3247 4.89148 4.95312 5.0454C4.58154 5.19933 4.24391 5.42494 3.95953 5.70935L1.77203 7.89685C1.19767 8.47121 0.875 9.25021 0.875 10.0625C0.875 10.8747 1.19767 11.6537 1.77203 12.2281C2.34639 12.8025 3.12539 13.1251 3.93766 13.1251C4.74992 13.1251 5.52892 12.8025 6.10328 12.2281L7.19703 11.1343C7.31295 11.0099 7.37606 10.8454 7.37306 10.6754C7.37006 10.5054 7.30119 10.3432 7.18095 10.2229C7.06071 10.1027 6.8985 10.0338 6.72849 10.0308C6.55848 10.0278 6.39393 10.0909 6.26953 10.2068L5.17578 11.3006C5.01325 11.4633 4.82025 11.5924 4.6078 11.6805C4.39535 11.7685 4.16763 11.8138 3.93766 11.8138C3.70768 11.8138 3.47996 11.7685 3.26751 11.6805C3.05506 11.5924 2.86206 11.4633 2.69953 11.3006Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</g>
|
||||
<defs>
|
||||
<clipPath id="clip0_1081_1237">
|
||||
<rect width="14" height="14" fill="white" />
|
||||
</clipPath>
|
||||
</defs>
|
||||
</svg>
|
||||
</a>
|
||||
Type Aliases</h2></div><div class="namespaceSection"><div id="namespace_clienttoservermessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-TypeAlias bg-TypeAlias/15 dark:text-TypeAliasDark dark:bg-TypeAliasDark/15" title="Type Alias">T</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ClientToServerMessage.html" title="ClientToServerMessage">
|
||||
<span>ClientToServerMessage</span><span> = <div class="ml-indent"><span><span class="td-ref">PingMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PongMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">VoteCastMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">VoteRemoveMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentLikeCastMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentLikeRemoveMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatSendMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatTypingMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatFocusMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatEditMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatDeleteMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatReadMessage</span></span></div></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>WSProvider</code>, and dispatched by the route's <code>handleMessage</code>, which
|
||||
checks each field's type before using it.</p>
|
||||
</div></div></div>
|
||||
</div><div id="namespace_servertoclientmessage" class="namespaceItem" ><div class="docNodeKindIcon"><div class="text-TypeAlias bg-TypeAlias/15 dark:text-TypeAliasDark dark:bg-TypeAliasDark/15" title="Type Alias">T</div></div>
|
||||
<div class="namespaceItemContent">
|
||||
<a href="../.././shared/ws.ts/~/ServerToClientMessage.html" title="ServerToClientMessage">
|
||||
<span>ServerToClientMessage</span><span> = <div class="ml-indent"><span><span class="td-ref">PingMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PongMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">WelcomeMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PresenceUpdateMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">VotesUpdateMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">VoteAckMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentLikesUpdateMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentLikeAckMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">DumpCreatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">DumpUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">DumpDeletedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">DumpRelatedChangedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PlaylistCreatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PlaylistUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PlaylistDeletedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">PlaylistDumpsUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">UserUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentCreatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CommentDeletedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">NotificationCreatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">NotificationsReadMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">CategoriesChangedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ErrorMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatMessageMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatMessageUpdatedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatMessageDeletedMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatTypingUpdateMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">ChatReadUpdateMessage</span></span><br /><span><span class="td-op"> | </span><span class="td-ref">FollowsChangedMessage</span></span></div></span></a><div class="namespaceItemContentDoc"><div class="markdown_summary"><p>Sent by <code>services/ws-service.ts</code> and the WebSocket route, and handled by
|
||||
<code>WSProvider</code>'s <code>onmessage</code>.</p>
|
||||
</div></div></div>
|
||||
</div></div>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</main><div class="toc">
|
||||
<div><div class="usageContent">
|
||||
<h3>Usage</h3><div class="markdown"><pre class="highlight"><code class="language-typescript">import * as mod from "shared/ws.ts";
|
||||
</code><button class="copyButton" data-copy="import * as mod from "shared/ws.ts";
|
||||
"><svg
|
||||
class="copy"
|
||||
width="15"
|
||||
height="15"
|
||||
viewBox="0 0 15 15"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<rect x="2" y="2" width="7" height="7" fill="none" />
|
||||
<rect x="6" y="6" width="7" height="7" fill="none" />
|
||||
<path
|
||||
d="M1.55566 2.7C1.55566 2.03726 2.09292 1.5 2.75566 1.5H8.75566C9.41841 1.5 9.95566 2.03726 9.95566 2.7V5.1H12.3557C13.0184 5.1 13.5557 5.63726 13.5557 6.3V12.3C13.5557 12.9627 13.0184 13.5 12.3557 13.5H6.35566C5.69292 13.5 5.15566 12.9627 5.15566 12.3V9.9H2.75566C2.09292 9.9 1.55566 9.36274 1.55566 8.7V2.7ZM6.35566 9.9V12.3H12.3557V6.3H9.95566V8.7C9.95566 9.36274 9.41841 9.9 8.75566 9.9H6.35566ZM8.75566 8.7V2.7H2.75566V8.7H8.75566Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
<svg
|
||||
class="check"
|
||||
width="15"
|
||||
height="15"
|
||||
viewBox="0 0 24 24"
|
||||
stroke-width="2"
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
stroke-linecap="round"
|
||||
stroke-linejoin="round"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M5 12l5 5l10 -10" />
|
||||
</svg>
|
||||
</button><code></code></pre>
|
||||
</div></div><nav class="topSymbols">
|
||||
<h3>Symbols</h3>
|
||||
<ul><li>
|
||||
<a href="../.././api/middleware/auth.ts/~/AuthState.html" title="AuthState"><div class="docNodeKindIcon"><div class="text-Interface bg-Interface/15 dark:text-InterfaceDark dark:bg-InterfaceDark/15" title="Interface">I</div></div>
|
||||
<span class="hover:bg-Interface/15 hover:bg-InterfaceDark/15">
|
||||
AuthState
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../.././api/middleware/auth.ts/~/AuthContext.html" title="AuthContext"><div class="docNodeKindIcon"><div class="text-TypeAlias bg-TypeAlias/15 dark:text-TypeAliasDark dark:bg-TypeAliasDark/15" title="Type Alias">T</div></div>
|
||||
<span class="hover:bg-TypeAlias/15 hover:bg-TypeAliasDark/15">
|
||||
AuthContext
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../.././api/middleware/auth.ts/~/authMiddleware.html" title="authMiddleware"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
authMiddleware
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../.././api/middleware/auth.ts/~/requirePermission.html" title="requirePermission"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
requirePermission
|
||||
</span>
|
||||
</a>
|
||||
</li><li>
|
||||
<a href="../.././api/middleware/error.ts/~/errorMiddleware.html" title="errorMiddleware"><div class="docNodeKindIcon"><div class="text-Function bg-Function/15 dark:text-FunctionDark dark:bg-FunctionDark/15" title="Function">f</div></div>
|
||||
<span class="hover:bg-Function/15 hover:bg-FunctionDark/15">
|
||||
errorMiddleware
|
||||
</span>
|
||||
</a>
|
||||
</li></ul><a class="flex items-center gap-0.5" href="../.././all_symbols.html">
|
||||
<span class="leading-none">view all 1307 symbols</span><svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 16 16"
|
||||
fill="none"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
>
|
||||
<path
|
||||
fill-rule="evenodd"
|
||||
clip-rule="evenodd"
|
||||
d="M5.76748 11.8159C5.5378 11.577 5.54525 11.1972 5.78411 10.9675L8.93431 8L5.78411 5.0325C5.54525 4.80282 5.5378 4.423 5.76748 4.18413C5.99715 3.94527 6.37698 3.93782 6.61584 4.1675L10.2158 7.5675C10.3335 7.68062 10.4 7.83679 10.4 8C10.4 8.16321 10.3335 8.31938 10.2158 8.4325L6.61584 11.8325C6.37698 12.0622 5.99715 12.0547 5.76748 11.8159Z"
|
||||
fill="currentColor"
|
||||
/>
|
||||
</svg>
|
||||
</a></nav><nav class="documentNavigation">
|
||||
<h3>Document Navigation</h3><ul><li><a href="#shared/ws_ts_interfaces" title="Interfaces">Interfaces</a></li><li><ul><li><a href="#namespace_categorieschangedmessage" title="CategoriesChangedMessage">CategoriesChangedMessage</a></li><li><a href="#namespace_chatdeletemessage" title="ChatDeleteMessage">ChatDeleteMessage</a></li><li><a href="#namespace_chateditmessage" title="ChatEditMessage">ChatEditMessage</a></li><li><a href="#namespace_chatfocusmessage" title="ChatFocusMessage">ChatFocusMessage</a></li><li><a href="#namespace_chatmessagedeletedmessage" title="ChatMessageDeletedMessage">ChatMessageDeletedMessage</a></li><li><a href="#namespace_chatmessagemessage" title="ChatMessageMessage">ChatMessageMessage</a></li><li><a href="#namespace_chatmessageupdatedmessage" title="ChatMessageUpdatedMessage">ChatMessageUpdatedMessage</a></li><li><a href="#namespace_chatreadmessage" title="ChatReadMessage">ChatReadMessage</a></li><li><a href="#namespace_chatreadupdatemessage" title="ChatReadUpdateMessage">ChatReadUpdateMessage</a></li><li><a href="#namespace_chatsendmessage" title="ChatSendMessage">ChatSendMessage</a></li><li><a href="#namespace_chattypingmessage" title="ChatTypingMessage">ChatTypingMessage</a></li><li><a href="#namespace_chattypingupdatemessage" title="ChatTypingUpdateMessage">ChatTypingUpdateMessage</a></li><li><a href="#namespace_commentcreatedmessage" title="CommentCreatedMessage">CommentCreatedMessage</a></li><li><a href="#namespace_commentdeletedmessage" title="CommentDeletedMessage">CommentDeletedMessage</a></li><li><a href="#namespace_commentlikeackmessage" title="CommentLikeAckMessage">CommentLikeAckMessage</a></li><li><a href="#namespace_commentlikecastmessage" title="CommentLikeCastMessage">CommentLikeCastMessage</a></li><li><a href="#namespace_commentlikeremovemessage" title="CommentLikeRemoveMessage">CommentLikeRemoveMessage</a></li><li><a href="#namespace_commentlikesupdatemessage" title="CommentLikesUpdateMessage">CommentLikesUpdateMessage</a></li><li><a href="#namespace_commentupdatedmessage" title="CommentUpdatedMessage">CommentUpdatedMessage</a></li><li><a href="#namespace_dumpcreatedmessage" title="DumpCreatedMessage">DumpCreatedMessage</a></li><li><a href="#namespace_dumpdeletedmessage" title="DumpDeletedMessage">DumpDeletedMessage</a></li><li><a href="#namespace_dumprelatedchangedmessage" title="DumpRelatedChangedMessage">DumpRelatedChangedMessage</a></li><li><a href="#namespace_dumpupdatedmessage" title="DumpUpdatedMessage">DumpUpdatedMessage</a></li><li><a href="#namespace_errormessage" title="ErrorMessage">ErrorMessage</a></li><li><a href="#namespace_followschangedmessage" title="FollowsChangedMessage">FollowsChangedMessage</a></li><li><a href="#namespace_notificationcreatedmessage" title="NotificationCreatedMessage">NotificationCreatedMessage</a></li><li><a href="#namespace_notificationsreadmessage" title="NotificationsReadMessage">NotificationsReadMessage</a></li><li><a href="#namespace_onlineuser" title="OnlineUser">OnlineUser</a></li><li><a href="#namespace_pingmessage" title="PingMessage">PingMessage</a></li><li><a href="#namespace_playlistcreatedmessage" title="PlaylistCreatedMessage">PlaylistCreatedMessage</a></li><li><a href="#namespace_playlistdeletedmessage" title="PlaylistDeletedMessage">PlaylistDeletedMessage</a></li><li><a href="#namespace_playlistdumpsupdatedmessage" title="PlaylistDumpsUpdatedMessage">PlaylistDumpsUpdatedMessage</a></li><li><a href="#namespace_playlistupdatedmessage" title="PlaylistUpdatedMessage">PlaylistUpdatedMessage</a></li><li><a href="#namespace_pongmessage" title="PongMessage">PongMessage</a></li><li><a href="#namespace_presenceupdatemessage" title="PresenceUpdateMessage">PresenceUpdateMessage</a></li><li><a href="#namespace_userupdatedmessage" title="UserUpdatedMessage">UserUpdatedMessage</a></li><li><a href="#namespace_voteackmessage" title="VoteAckMessage">VoteAckMessage</a></li><li><a href="#namespace_votecastmessage" title="VoteCastMessage">VoteCastMessage</a></li><li><a href="#namespace_voteremovemessage" title="VoteRemoveMessage">VoteRemoveMessage</a></li><li><a href="#namespace_votesupdatemessage" title="VotesUpdateMessage">VotesUpdateMessage</a></li><li><a href="#namespace_welcomemessage" title="WelcomeMessage">WelcomeMessage</a></li></ul></li><li><a href="#shared/ws_ts_type-aliases" title="Type Aliases">Type Aliases</a></li><li><ul><li><a href="#namespace_clienttoservermessage" title="ClientToServerMessage">ClientToServerMessage</a></li><li><a href="#namespace_servertoclientmessage" title="ServerToClientMessage">ServerToClientMessage</a></li></ul></li></ul></nav></div>
|
||||
</div></div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user