actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
291 lines • 14.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ChatRoomApi | actionhero</title>
<meta name="description" content="Documentation for actionhero">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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">actionhero</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="chatroomapi.html">ChatRoomApi</a>
</li>
</ul>
<h1>Interface ChatRoomApi</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ChatRoomApi</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#broadcast" class="tsd-kind-icon">broadcast</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#generatemessagepayload" class="tsd-kind-icon">generate<wbr>Message<wbr>Payload</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#globalmiddleware" class="tsd-kind-icon">global<wbr>Middleware</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#incomingmessage" class="tsd-kind-icon">incoming<wbr>Message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#incomingmessageperconnection" class="tsd-kind-icon">incoming<wbr>Message<wbr>Per<wbr>Connection</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#keys" class="tsd-kind-icon">keys</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#messagechannel" class="tsd-kind-icon">message<wbr>Channel</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#middleware" class="tsd-kind-icon">middleware</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="chatroomapi.html#runmiddleware" class="tsd-kind-icon">run<wbr>Middleware</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="broadcast" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> broadcast</h3>
<div class="tsd-signature tsd-kind-icon">broadcast<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L12">src/initializers/chatRoom.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="generatemessagepayload" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr>Message<wbr>Payload</h3>
<div class="tsd-signature tsd-kind-icon">generate<wbr>Message<wbr>Payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L13">src/initializers/chatRoom.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="globalmiddleware" class="tsd-anchor"></a>
<h3>global<wbr>Middleware</h3>
<div class="tsd-signature tsd-kind-icon">global<wbr>Middleware<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><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/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L9">src/initializers/chatRoom.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="incomingmessage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> incoming<wbr>Message</h3>
<div class="tsd-signature tsd-kind-icon">incoming<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L16">src/initializers/chatRoom.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="incomingmessageperconnection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> incoming<wbr>Message<wbr>Per<wbr>Connection</h3>
<div class="tsd-signature tsd-kind-icon">incoming<wbr>Message<wbr>Per<wbr>Connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L15">src/initializers/chatRoom.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="keys" class="tsd-anchor"></a>
<h3>keys</h3>
<div class="tsd-signature tsd-kind-icon">keys<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/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L10">src/initializers/chatRoom.ts:10</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>keys: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="messagechannel" class="tsd-anchor"></a>
<h3>message<wbr>Channel</h3>
<div class="tsd-signature tsd-kind-icon">message<wbr>Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L11">src/initializers/chatRoom.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="middleware" class="tsd-anchor"></a>
<h3>middleware</h3>
<div class="tsd-signature tsd-kind-icon">middleware<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/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L6">src/initializers/chatRoom.ts:6</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="chatroom.chatmiddleware.html" class="tsd-signature-type">ChatMiddleware</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="runmiddleware" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> run<wbr>Middleware</h3>
<div class="tsd-signature tsd-kind-icon">run<wbr>Middleware<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/initializers/chatRoom.ts#L14">src/initializers/chatRoom.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="chatroomapi.html" class="tsd-kind-icon">Chat<wbr>Room<wbr>Api</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#broadcast" class="tsd-kind-icon">broadcast</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#generatemessagepayload" class="tsd-kind-icon">generate<wbr>Message<wbr>Payload</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#globalmiddleware" class="tsd-kind-icon">global<wbr>Middleware</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#incomingmessage" class="tsd-kind-icon">incoming<wbr>Message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#incomingmessageperconnection" class="tsd-kind-icon">incoming<wbr>Message<wbr>Per<wbr>Connection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#keys" class="tsd-kind-icon">keys</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#messagechannel" class="tsd-kind-icon">message<wbr>Channel</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#middleware" class="tsd-kind-icon">middleware</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="chatroomapi.html#runmiddleware" class="tsd-kind-icon">run<wbr>Middleware</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-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-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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>
<ul class="tsd-legend">
<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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>