UNPKG

@betit/orion-node-sdk

Version:
786 lines (785 loc) 70.4 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Service | @betit/orion-node-sdk</title> <meta name="description" content=""> <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.js" 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">@betit/orion-node-sdk</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="../modules/_service_index_.html">&quot;service/index&quot;</a> </li> <li> <a href="_service_index_.service.html">Service</a> </li> </ul> <h1>Class Service</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>Provides an interface to create your service and register request handlers.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Service</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="_service_index_.service.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 tsd-is-private"><a href="_service_index_.service.html#_codec" class="tsd-kind-icon">_codec</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_enablestatusendpoints" class="tsd-kind-icon">_enable<wbr>Status<wbr>Endpoints</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_healthchecks" class="tsd-kind-icon">_health<wbr>Checks</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_registertowatchdog" class="tsd-kind-icon">_register<wbr>ToWatchdog</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_tracer" class="tsd-kind-icon">_tracer</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_transport" class="tsd-kind-icon">_transport</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_watchdogservicename" class="tsd-kind-icon">_watchdog<wbr>Service<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_service_index_.service.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_service_index_.service.html#logger" class="tsd-kind-icon">logger</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_service_index_.service.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="_service_index_.service.html#options" class="tsd-kind-icon">options</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 tsd-is-private"><a href="_service_index_.service.html#_call" class="tsd-kind-icon">_call</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_checkresponse" class="tsd-kind-icon">_check<wbr>Response</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_getcalltimeout" class="tsd-kind-icon">_get<wbr>Call<wbr>Timeout</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_handle" class="tsd-kind-icon">_handle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#_serializerequest" class="tsd-kind-icon">_serialize<wbr>Request</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_service_index_.service.html#call" class="tsd-kind-icon">call</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#checkhealthortimeout" class="tsd-kind-icon">check<wbr>Health<wbr>OrTimeout</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#close" class="tsd-kind-icon">close</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#commswithwatchdog" class="tsd-kind-icon">comms<wbr>With<wbr>Watchdog</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#emit" class="tsd-kind-icon">emit</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_service_index_.service.html#handle" class="tsd-kind-icon">handle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#handlehealthcheck" class="tsd-kind-icon">handle<wbr>Health<wbr>Check</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_service_index_.service.html#handlewithoutlogging" class="tsd-kind-icon">handle<wbr>Without<wbr>Logging</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#listen" class="tsd-kind-icon">listen</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_service_index_.service.html#listentohealthchecks" class="tsd-kind-icon">listen<wbr>ToHealth<wbr>Checks</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#on" class="tsd-kind-icon">on</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_service_index_.service.html#onasync" class="tsd-kind-icon">on<wbr>Async</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#onclose" class="tsd-kind-icon">on<wbr>Close</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#registerhealthcheck" class="tsd-kind-icon">register<wbr>Health<wbr>Check</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_index_.service.html#tostring" class="tsd-kind-icon">to<wbr>String</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>Service<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_types_interfaces_.options.html" class="tsd-signature-type">Options</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_service_index_.service.html" class="tsd-signature-type">Service</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L61">service/index.ts:61</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create new service.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/_types_interfaces_.options.html" class="tsd-signature-type">Options</a><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_service_index_.service.html" class="tsd-signature-type">Service</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 tsd-is-private"> <a name="_codec" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _codec</h3> <div class="tsd-signature tsd-kind-icon">_codec<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_interfaces_.codec.html" class="tsd-signature-type">Codec</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L55">service/index.ts:55</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_enablestatusendpoints" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _enable<wbr>Status<wbr>Endpoints</h3> <div class="tsd-signature tsd-kind-icon">_enable<wbr>Status<wbr>Endpoints<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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L60">service/index.ts:60</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_healthchecks" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _health<wbr>Checks</h3> <div class="tsd-signature tsd-kind-icon">_health<wbr>Checks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L58">service/index.ts:58</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>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="../interfaces/_health_health_.dependency.html" class="tsd-signature-type">Dependency</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_registertowatchdog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _register<wbr>ToWatchdog</h3> <div class="tsd-signature tsd-kind-icon">_register<wbr>ToWatchdog<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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L61">service/index.ts:61</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_tracer" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _tracer</h3> <div class="tsd-signature tsd-kind-icon">_tracer<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_interfaces_.tracer.html" class="tsd-signature-type">Tracer</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L57">service/index.ts:57</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_transport" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _transport</h3> <div class="tsd-signature tsd-kind-icon">_transport<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_interfaces_.transport.html" class="tsd-signature-type">Transport</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L56">service/index.ts:56</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_watchdogservicename" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _watchdog<wbr>Service<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">_watchdog<wbr>Service<wbr>Name<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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L59">service/index.ts:59</a></li> </ul> </aside> </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><span class="tsd-signature-symbol"> =&nbsp;generateId()</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L52">service/index.ts:52</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="logger" class="tsd-anchor"></a> <h3>logger</h3> <div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_interfaces_.logger.html" class="tsd-signature-type">Logger</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L54">service/index.ts:54</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="name" class="tsd-anchor"></a> <h3>name</h3> <div class="tsd-signature tsd-kind-icon">name<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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L66">service/index.ts:66</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="options" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3> <div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_types_interfaces_.options.html" class="tsd-signature-type">Options</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L66">service/index.ts:66</a></li> </ul> </aside> </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 tsd-is-private"> <a name="_call" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _call</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_call<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, req<span class="tsd-signature-symbol">: </span><a href="_request_request_.request.html" class="tsd-signature-type">Request</a>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a><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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L334">service/index.ts:334</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>route: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>req: <a href="_request_request_.request.html" class="tsd-signature-type">Request</a></h5> </li> <li> <h5>callback: <a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a></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="_checkresponse" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _check<wbr>Response</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_check<wbr>Response<span class="tsd-signature-symbol">(</span>res<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">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L443">service/index.ts:443</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>res: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="_getcalltimeout" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _get<wbr>Call<wbr>Timeout</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_get<wbr>Call<wbr>Timeout<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, timeout<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-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L326">service/index.ts:326</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>timeout: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="_handle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _handle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_handle<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a>, logging<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, prefix<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">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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L354">service/index.ts:354</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a></h5> </li> <li> <h5>logging: <span class="tsd-signature-type">boolean</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</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="_serializerequest" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _serialize<wbr>Request</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">_serialize<wbr>Request<span class="tsd-signature-symbol">(</span>request<span class="tsd-signature-symbol">: </span><a href="_request_request_.request.html" class="tsd-signature-type">Request</a>, callback<span class="tsd-signature-symbol">?: </span><a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a><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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L410">service/index.ts:410</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>request: <a href="_request_request_.request.html" class="tsd-signature-type">Request</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a></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 tsd-has-type-parameter"> <a name="call" class="tsd-anchor"></a> <h3>call</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">call&lt;T&gt;<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="_request_request_.request.html" class="tsd-signature-type">Request</a>, callback<span class="tsd-signature-symbol">?: </span><a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</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">&lt;</span><a href="_response_response_.response.html" class="tsd-signature-type">Response</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L307">service/index.ts:307</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Call service method.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>req: <a href="_request_request_.request.html" class="tsd-signature-type">Request</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <a href="../modules/_service_index_.html#callbackrequestfunction" class="tsd-signature-type">CallbackRequestFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="_response_response_.response.html" class="tsd-signature-type">Response</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>returns promise if called with no callback.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="checkhealthortimeout" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>Health<wbr>OrTimeout</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">check<wbr>Health<wbr>OrTimeout<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, check<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</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">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_error_error_.orionerror.html" class="tsd-signature-type">OrionError</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L170">service/index.ts:170</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>timeout: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>check: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><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">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="_error_error_.orionerror.html" class="tsd-signature-type">OrionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="_error_error_.orionerror.html" class="tsd-signature-type">OrionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_error_error_.orionerror.html" class="tsd-signature-type">OrionError</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="close" class="tsd-anchor"></a> <h3>close</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L260">service/index.ts:260</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Close underlying transport connection.</p> </div> </div> <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="commswithwatchdog" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> comms<wbr>With<wbr>Watchdog</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">comms<wbr>With<wbr>Watchdog<span class="tsd-signature-symbol">(</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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L81">service/index.ts:81</a></li> </ul> </aside> <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"> <a name="emit" class="tsd-anchor"></a> <h3>emit</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L288">service/index.ts:288</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Publish to a topic.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>topic: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>message: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> </div> </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-has-type-parameter"> <a name="handle" class="tsd-anchor"></a> <h3>handle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">handle&lt;T&gt;<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, prefix<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">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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L217">service/index.ts:217</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Register request handler method with enabled logging.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</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="handlehealthcheck" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> handle<wbr>Health<wbr>Check</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">handle<wbr>Health<wbr>Check<span class="tsd-signature-symbol">(</span>healthCheckName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a><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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L113">service/index.ts:113</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>healthCheckName: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>handler: <a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a></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-has-type-parameter"> <a name="handlewithoutlogging" class="tsd-anchor"></a> <h3>handle<wbr>Without<wbr>Logging</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">handle<wbr>Without<wbr>Logging&lt;T&gt;<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, prefix<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">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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L228">service/index.ts:228</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Register request handler method with disabled logging.</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>T</h4> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <a href="../modules/_service_index_.html#callbackhandlefunction" class="tsd-signature-type">CallbackHandleFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</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"> <a name="listen" class="tsd-anchor"></a> <h3>listen</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Function</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L238">service/index.ts:238</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start listenning on the underlying transport connection.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">Function</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>returns promise if called with no callback.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="listentohealthchecks" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> listen<wbr>ToHealth<wbr>Checks</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">listen<wbr>ToHealth<wbr>Checks<span class="tsd-signature-symbol">(</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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L104">service/index.ts:104</a></li> </ul> </aside> <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"> <a name="on" class="tsd-anchor"></a> <h3>on</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span>, disableGroup<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><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/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L186">service/index.ts:186</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Subscribe to a topic.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>topic: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>callback: <span class="tsd-signature-type">Function</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> disableGroup: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5> <div class="tsd-comment tsd-typography"> </div> </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 tsd-has-type-parameter"> <a name="onasync" class="tsd-anchor"></a> <h3>on<wbr>Async</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">on<wbr>Async&lt;T&gt;<span class="tsd-signature-symbol">(</span>topic<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, disableGroup<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="_utils_asyncarray_.asyncarray.html" class="tsd-signature-type">AsyncArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/service/index.ts#L200">service/index.ts:200</a></li> </ul> </aside>