actionhero
Version:
actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks
865 lines • 53.3 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Connection | 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="connection.html">Connection</a>
</li>
</ul>
<h1>Class Connection</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The generic representation of a connection for all server types is an Actionhero.Connection. You will never be creating these yourself via an action or task, but you will find them in your Actions and Action Middleware.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Connection</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="connection.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#canchat" class="tsd-kind-icon">can<wbr>Chat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#connectedat" class="tsd-kind-icon">connected<wbr>At</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#destroyed" class="tsd-kind-icon">destroyed</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#extension" class="tsd-kind-icon">extension</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#fingerprint" class="tsd-kind-icon">fingerprint</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#matchedroute" class="tsd-kind-icon">matched<wbr>Route</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#messageid" class="tsd-kind-icon">message<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#messages" class="tsd-kind-icon">messages</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#pendingactions" class="tsd-kind-icon">pending<wbr>Actions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#pipe" class="tsd-kind-icon">pipe</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#rawconnection" class="tsd-kind-icon">raw<wbr>Connection</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#remoteip" class="tsd-kind-icon">remoteIP</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#remoteport" class="tsd-kind-icon">remote<wbr>Port</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#rooms" class="tsd-kind-icon">rooms</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#setheader" class="tsd-kind-icon">set<wbr>Header</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#setstatuscode" class="tsd-kind-icon">set<wbr>Status<wbr>Code</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#totalactions" class="tsd-kind-icon">total<wbr>Actions</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="connection.html#type" class="tsd-kind-icon">type</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="connection.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="connection.html#generateid" class="tsd-kind-icon">generateID</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="connection.html#localize" class="tsd-kind-icon">localize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="connection.html#sendfile" class="tsd-kind-icon">send<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="connection.html#sendmessage" class="tsd-kind-icon">send<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="connection.html#set" class="tsd-kind-icon">set</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="connection.html#setup" class="tsd-kind-icon">setup</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="connection.html#verbs" class="tsd-kind-icon">verbs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="connection.html#callconnectioncreatemethods" class="tsd-kind-icon">call<wbr>Connection<wbr>Create<wbr>Methods</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="connection.html#createasync" class="tsd-kind-icon">create<wbr>Async</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Connection<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, callCreateMethods<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="connection.html" class="tsd-signature-type">Connection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L51">src/classes/connection.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The specifics of this connection</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> callCreateMethods: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The specifics of this connection will calls create methods in the constructor. This property will exist for backward compatibility. If you want to construct connection and call create methods within async, you can use <code>await Actionhero.Connection.createAsync(details)</code> for construction.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="connection.html" class="tsd-signature-type">Connection</a></h4>
</li>
</ul>
</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-class">
<a name="canchat" class="tsd-anchor"></a>
<h3>can<wbr>Chat</h3>
<div class="tsd-signature tsd-kind-icon">can<wbr>Chat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L19">src/classes/connection.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Can this connection use the chat system?</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="connectedat" class="tsd-anchor"></a>
<h3>connected<wbr>At</h3>
<div class="tsd-signature tsd-kind-icon">connected<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L29">src/classes/connection.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The timestamp of when this connection was created</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="destroyed" class="tsd-anchor"></a>
<h3>destroyed</h3>
<div class="tsd-signature tsd-kind-icon">destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L40">src/classes/connection.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3>
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L37">src/classes/connection.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If there's a local error</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="extension" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> extension</h3>
<div class="tsd-signature tsd-kind-icon">extension<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/classes/connection.ts#L39">src/classes/connection.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If there's a local extension to the request</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fingerprint" class="tsd-anchor"></a>
<h3>fingerprint</h3>
<div class="tsd-signature tsd-kind-icon">fingerprint<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/classes/connection.ts#L13">src/classes/connection.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A unique string identifer for this connection, but common among subsequent requests. For example, all web requests from the same client have the same fingerprint, but not the same id</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<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/classes/connection.ts#L11">src/classes/connection.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A unique string identifer for this connection.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="matchedroute" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> matched<wbr>Route</h3>
<div class="tsd-signature tsd-kind-icon">matched<wbr>Route<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/classes/connection.ts#L50">src/classes/connection.ts:50</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="messageid" class="tsd-anchor"></a>
<h3>message<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">message<wbr>Id<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/classes/connection.ts#L27">src/classes/connection.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Id of the latest message this connection has sent to the server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="messages" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> messages</h3>
<div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L45">src/classes/connection.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>for specHelper</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="params" class="tsd-anchor"></a>
<h3>params</h3>
<div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <a href="../interfaces/connectionparams.html" class="tsd-signature-type">ConnectionParams</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L21">src/classes/connection.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Any params this connection has saved for use in subsequent Actions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="pendingactions" class="tsd-anchor"></a>
<h3>pending<wbr>Actions</h3>
<div class="tsd-signature tsd-kind-icon">pending<wbr>Actions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L23">src/classes/connection.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>How many actions are currently running for this connection? Most server types have a limit</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="pipe" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> pipe</h3>
<div class="tsd-signature tsd-kind-icon">pipe<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/classes/connection.ts#L51">src/classes/connection.ts:51</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="rawconnection" class="tsd-anchor"></a>
<h3>raw<wbr>Connection</h3>
<div class="tsd-signature tsd-kind-icon">raw<wbr>Connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L35">src/classes/connection.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Any connection-specific properties. For, example, the HTTP res and req objects for <code>web</code> connections are here</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="remoteip" class="tsd-anchor"></a>
<h3>remoteIP</h3>
<div class="tsd-signature tsd-kind-icon">remoteIP<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/classes/connection.ts#L31">src/classes/connection.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The remote connection's IP address (as best as we can tell). May be either IPv4 or IPv6.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="remoteport" class="tsd-anchor"></a>
<h3>remote<wbr>Port</h3>
<div class="tsd-signature tsd-kind-icon">remote<wbr>Port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L33">src/classes/connection.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The remote connection's port. Related to connection.remoteIP</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="rooms" class="tsd-anchor"></a>
<h3>rooms</h3>
<div class="tsd-signature tsd-kind-icon">rooms<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/classes/connection.ts#L17">src/classes/connection.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Any rooms this connection is a member of, it it can chat</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="setheader" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> set<wbr>Header</h3>
<div class="tsd-signature tsd-kind-icon">set<wbr>Header<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L48">src/classes/connection.ts:48</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
<ul class="tsd-parameters">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="setstatuscode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> set<wbr>Status<wbr>Code</h3>
<div class="tsd-signature tsd-kind-icon">set<wbr>Status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><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/classes/connection.ts#L49">src/classes/connection.ts:49</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>code: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span></h4>
<ul class="tsd-parameters">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="totalactions" class="tsd-anchor"></a>
<h3>total<wbr>Actions</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Actions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L25">src/classes/connection.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>How many actions has this connection run since it connected.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<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/classes/connection.ts#L15">src/classes/connection.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The type of this connection (web, websocket, etc) as defined by the name of the server which created it</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L178">src/classes/connection.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Destroys the connection. If the type/sever of the connection has a goodbye message, it will be sent. The connection will be removed from all rooms. The connection's socket will be closed when possible.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="generateid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> generateID</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">generateID<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L171">src/classes/connection.ts:171</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="localize" class="tsd-anchor"></a>
<h3>localize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">localize<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L151">src/classes/connection.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Localize a key for this connection's locale. Keys usually look like <code>messages.errors.notFound</code>, and are defined in your locales directory. Strings can be interpolated as well, connection.localize('the count was {{count}}', {count: 4})</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sendfile" class="tsd-anchor"></a>
<h3>send<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L160">src/classes/connection.ts:160</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send a file to a connection (usually in the context of an Action). Be sure to set <code>data.toRender = false</code> in the action!
Uses Server#processFile and will set <code>connection.params.file = path</code></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="sendmessage" class="tsd-anchor"></a>
<h3>send<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, verb<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L167">src/classes/connection.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send a message to a connection. Uses Server#sendMessage.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> verb: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="set" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> set</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">set<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L213">src/classes/connection.ts:213</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="setup" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> setup</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">setup<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L85">src/classes/connection.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="verbs" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> verbs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">verbs<span class="tsd-signature-symbol">(</span>verb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, words<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L220">src/classes/connection.ts:220</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Try to run a verb command for a connection</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>verb: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>words: <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></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="callconnectioncreatemethods" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> call<wbr>Connection<wbr>Create<wbr>Methods</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static">
<li class="tsd-signature tsd-kind-icon">call<wbr>Connection<wbr>Create<wbr>Methods<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L74">src/classes/connection.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>connection: <a href="connection.html" class="tsd-signature-type">Connection</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="createasync" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Async</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">create<wbr>Async<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/actionhero/actionhero/blob/fd12b4f0/src/classes/connection.ts#L68">src/classes/connection.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The specifics of this connection</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="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-class">
<a href="connection.html" class="tsd-kind-icon">Connection</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="connection.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#canchat" class="tsd-kind-icon">can<wbr>Chat</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#connectedat" class="tsd-kind-icon">connected<wbr>At</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#destroyed" class="tsd-kind-icon">destroyed</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#extension" class="tsd-kind-icon">extension</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#fingerprint" class="tsd-kind-icon">fingerprint</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#matchedroute" class="tsd-kind-icon">matched<wbr>Route</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#messageid" class="tsd-kind-icon">message<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#messages" class="tsd-kind-icon">messages</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#pendingactions" class="tsd-kind-icon">pending<wbr>Actions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#pipe" class="tsd-kind-icon">pipe</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#rawconnection" class="tsd-kind-icon">raw<wbr>Connection</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#remoteip" class="tsd-kind-icon">remoteIP</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#remoteport" class="tsd-kind-icon">remote<wbr>Port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#rooms" class="tsd-kind-icon">rooms</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#setheader" class="tsd-kind-icon">set<wbr>Header</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#setstatuscode" class="tsd-kind-icon">set<wbr>Status<wbr>Code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#totalactions" class="tsd-kind-icon">total<wbr>Actions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="connection.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="connection.html#de