@betit/orion-node-sdk
Version:
SDK for orion
365 lines • 18.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AmIUpResponse | @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/_health_messages_.html">"health/messages"</a>
</li>
<li>
<a href="_health_messages_.amiupresponse.html">AmIUpResponse</a>
</li>
</ul>
<h1>Class AmIUpResponse<T></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_response_response_.response.html" class="tsd-signature-type">Response</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">AmIUpResponse</span>
</li>
</ul>
</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 tsd-is-overwrite"><a href="_health_messages_.amiupresponse.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-inherited"><a href="_health_messages_.amiupresponse.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_health_messages_.amiupresponse.html#payload" class="tsd-kind-icon">payload</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 tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>AmIUp<wbr>Response<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_health_messages_.amiupresponse.html" class="tsd-signature-type">AmIUpResponse</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_response_response_.response.html">Response</a>.<a href="_response_response_.response.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/health/messages.ts#L23">health/messages.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_health_messages_.amiupresponse.html" class="tsd-signature-type">AmIUpResponse</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-inherited">
<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> <a href="_error_error_.orionerror.html" class="tsd-signature-type">OrionError</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_response_response_.response.html">Response</a>.<a href="_response_response_.response.html#error">error</a></p>
<ul>
<li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/response/response.ts#L5">response/response.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="payload" class="tsd-anchor"></a>
<h3>payload</h3>
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/health/messages.ts#L27">health/messages.ts:27</a></li>
<li>Defined in <a href="https://github.com/GiG/orion-node-sdk/blob/201b970/src/response/response.ts#L5">response/response.ts:5</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>
<li class=" tsd-kind-external-module">
<a href="../modules/_codec_index_.html">"codec/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_codec_json_.html">"codec/json"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_codec_msgpack_.html">"codec/msgpack"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_error_error_.html">"error/error"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_health_health_.html">"health/health"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_health_messages_.html">"health/messages"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_logger_colors_.html">"logger/colors"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_logger_levels_.html">"logger/levels"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_logger_logger_.html">"logger/logger"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_logger_message_.html">"logger/message"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_orion_.html">"orion"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_request_request_.html">"request/request"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_response_response_.html">"response/response"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_service_index_.html">"service/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_tracer_tracer_.html">"tracer/tracer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_transport_index_.html">"transport/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_transport_kafka_.html">"transport/kafka"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_transport_nats_.html">"transport/nats"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_types_interfaces_.html">"types/interfaces"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_utils_asyncarray_.html">"utils/async<wbr>Array"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_utils_index_.html">"utils/index"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_health_messages_.aggregationtype.html" class="tsd-kind-icon">Aggregation<wbr>Type</a>
</li>
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_health_messages_.healthcheckresult.html" class="tsd-kind-icon">Health<wbr>Check<wbr>Result</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.aggregaterequest.html" class="tsd-kind-icon">Aggregate<wbr>Request</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.aggregateresponse.html" class="tsd-kind-icon">Aggregate<wbr>Response</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.amiuprequest.html" class="tsd-kind-icon">AmIUp<wbr>Request</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.amiupresponse.html" class="tsd-kind-icon">AmIUp<wbr>Response</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="_health_messages_.amiupresponse.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_health_messages_.amiupresponse.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_health_messages_.amiupresponse.html#payload" class="tsd-kind-icon">payload</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.dependencyrequest.html" class="tsd-kind-icon">Dependency<wbr>Request</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="_health_messages_.dependencyresponse.html" class="tsd-kind-icon">Dependency<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_health_messages_.aggregateparams.html" class="tsd-kind-icon">Aggregate<wbr>Params</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_health_messages_.dependencycheckresult.html" class="tsd-kind-icon">Dependency<wbr>Check<wbr>Result</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module">
<a href="../modules/_health_messages_.html#who_are_you" class="tsd-kind-icon">WHO_<wbr>ARE_<wbr>YOU</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/_health_messages_.html#aggregatehandlegenerator" class="tsd-kind-icon">Aggregate<wbr>Handle<wbr>Generator</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/_health_messages_.html#amiuphandle" class="tsd-kind-icon">AmIUp<wbr>Handle</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/_health_messages_.html#dependencyhandlegenerator" class="tsd-kind-icon">Dependency<wbr>Handle<wbr>Generator</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_health_messages_.html#checktoobject" class="tsd-kind-icon">check<wbr>ToObject</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature 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>