@toreda/types

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@toreda/types - v2.13.1</title><meta name="description" content="Documentation for @toreda/types - v2.13.1"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@toreda/types - v2.13.1</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">All<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></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"><h1>@toreda/types - v2.13.1 </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><a href="https://www.toreda.com"><img src="https://content.toreda.com/logo/toreda-logo.png" alt="Toreda"></a> <a href="https://github.com/toreda/types/actions"><img src="https://img.shields.io/github/workflow/status/toreda/types/CI?style=for-the-badge" alt="CI"></a> <a href="https://sonarcloud.io/project/activity?graph=coverage&id=toreda_types"><img src="https://img.shields.io/sonar/coverage/toreda_types?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge" alt="Coverage"></a> <a href="https://sonarcloud.io/summary/new_code?id=toreda_types"><img src="https://img.shields.io/sonar/quality_gate/toreda_types?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge" alt="Sonar Quality Gate"></a> <a href="https://github.com/toreda/types/releases/latest"><img src="https://img.shields.io/github/package-json/v/toreda/types/master?style=for-the-badge" alt="GitHub package.json version (branch)"></a> <a href="https://github.com/toreda/types/releases/latest"><img src="https://img.shields.io/github/release-date/toreda/types?style=for-the-badge" alt="GitHub Release Date"></a> <a href="https://github.com/toreda/types/issues"><img src="https://img.shields.io/github/issues/toreda/types?style=for-the-badge" alt="GitHub issues"></a> <a href="https://github.com/toreda/types/blob/master/LICENSE"><img src="https://img.shields.io/github/license/toreda/types?style=for-the-badge" alt="license"></a>   <a href="#toredatypes" id="toredatypes" style="color: inherit; text-decoration: none;"> <h1><code>@toreda/types</code></h1> </a> Improve readability, reduce redundancy. Functional & Expressive Types used in <a href="https://www.toreda.com">Toreda</a> packages.   <a href="#contents" id="contents" style="color: inherit; text-decoration: none;"> <h1>Contents</h1> </a> <ul> <li><a href="#toredatypes"><code>@toreda/types</code></a></li> <li><a href="#contents">Contents</a></li> <li><a href="#object-api">Object API</a><ul> <li><a href="#resettable"><code>Resettable</code></a><ul> <li><a href="#example">Example</a></li> </ul> </li> <li><a href="#clearable"><code>Clearable</code></a><ul> <li><a href="#example-1">Example</a></li> </ul> </li> <li><a href="#stringable"><code>Stringable</code></a><ul> <li><a href="#example-2">Example</a></li> </ul> </li> </ul> </li> <li><a href="#functional-types">Functional Types</a><ul> <li><a href="#deeprequiredt"><code>DeepRequired<T></code></a></li> <li><a href="#primitive"><code>Primitive</code></a><ul> <li><a href="#import">Import</a></li> <li><a href="#use">Use</a></li> </ul> </li> <li><a href="#stringable-1"><code>Stringable</code></a><ul> <li><a href="#import-1">Import</a></li> <li><a href="#use-1">Use</a></li> </ul> </li> </ul> </li> <li><a href="#expressive-types">Expressive Types</a><ul> <li><a href="#bitmask"><code>BitMask</code></a><ul> <li><a href="#import-2">Import</a></li> <li><a href="#use-2">Use</a></li> </ul> </li> </ul> </li> <li><a href="#install">Install</a><ul> <li><a href="#yarn">Yarn</a></li> <li><a href="#npm">NPM</a></li> </ul> </li> <li><a href="#legal">Legal</a><ul> <li><a href="#license">License</a></li> <li><a href="#copyright">Copyright</a></li> <li><a href="#website">Website</a></li> </ul> </li> </ul>   <a href="#object-api" id="object-api" style="color: inherit; text-decoration: none;"> <h1>Object API</h1> </a> <a href="#resettable" id="resettable" style="color: inherit; text-decoration: none;"> <h2><code>Resettable</code></h2> </a> Interface indicating implementer provides a <code>reset</code> method. <a href="#example" id="example" style="color: inherit; text-decoration: none;"> <h3>Example</h3> </a> <pre><code class="language-typescript">import type {Resettable} from '@toreda/types'; class MyObj implements Resettable { public reset(): void { console.log('boop'); } } const o = new MyObj(); o.reset(); </code></pre> <a href="#clearable" id="clearable" style="color: inherit; text-decoration: none;"> <h2><code>Clearable</code></h2> </a> Interface indicating implementer provides a <code>clear()</code> method. Callers expect <code>true</code> to be returned when <code>clear</code> call is successful and <code>false</code> when it was not successful, or there was nothing to clear. <a href="#example-1" id="example-1" style="color: inherit; text-decoration: none;"> <h3>Example</h3> </a> <pre><code class="language-typescript">import type {Clearable} from '@toreda/types'; class MyObj implements Clearable { public clear(): boolean { console.log('boop'); return true; } } const o = new MyObj(); const result = o.clear(); </code></pre> <a href="#stringable" id="stringable" style="color: inherit; text-decoration: none;"> <h2><code>Stringable</code></h2> </a> Interface indicating implementer provides a <code>toString()</code> method which returns the object contents as a string. Typically used for serialization although usage may vary. <a href="#example-2" id="example-2" style="color: inherit; text-decoration: none;"> <h3>Example</h3> </a> <pre><code class="language-typescript">import type {Stringable} from '@toreda/types'; class MyObj implements Stringable { public a: string; public b: string; constructor() { this.a = 'aaaa'; this.b = 'bbbb'; } public toString(): string | null { const o = { a: this.a, b: this.b }; let result: string | null = null; try { result = JSON.stringify(o); } catch (e){ if (e instanceof Error) { console.log(`toString exception: ${e.message}.`); } } return result; } } const o = new MyObj(); const result = o.clear(); </code></pre> <a href="#functional-types" id="functional-types" style="color: inherit; text-decoration: none;"> <h1>Functional Types</h1> </a> Types & aliases provide shorthand to reduce code duplication and simplify statements.   <a href="#deeprequiredlttgt" id="deeprequiredlttgt" style="color: inherit; text-decoration: none;"> <h2><code>DeepRequired<T></code></h2> </a> Recursively require all properties on object & children.   <a href="#primitive" id="primitive" style="color: inherit; text-decoration: none;"> <h2><code>Primitive</code></h2> </a> Implementer's type is any JavaScript primitive. <a href="#import" id="import" style="color: inherit; text-decoration: none;"> <h3>Import</h3> </a> <pre><code class="language-typescript">import {Primitive} from '@toreda/types' </code></pre> <a href="#use" id="use" style="color: inherit; text-decoration: none;"> <h3>Use</h3> </a> <pre><code class="language-typescript">const myValue: Primitive = null; </code></pre>   <a href="#stringable-1" id="stringable-1" style="color: inherit; text-decoration: none;"> <h2><code>Stringable</code></h2> </a> Implementer's contents can be converted to a string by calling <code>toString()</code>. <a href="#import-1" id="import-1" style="color: inherit; text-decoration: none;"> <h3>Import</h3> </a> <pre><code class="language-typescript">import {Stringable} from '@toreda/types' </code></pre> <a href="#use-1" id="use-1" style="color: inherit; text-decoration: none;"> <h3>Use</h3> </a> <pre><code class="language-typescript">export class MyClass implements Stringable { public toString(): string { return 'stringified_contents_here'; } } </code></pre> Example <pre><code class="language-typescript">// Simple generic mapping. When used only once, exporting a type is overkill, but when used repeatedly // using a common definition reduces chances for mistakes and reduces line lengths. export type Data<T> = Record<string, T | T[] | null>; </code></pre>   <a href="#expressive-types" id="expressive-types" style="color: inherit; text-decoration: none;"> <h1>Expressive Types</h1> </a> Express value intent & purpose with type definitions.   <a href="#bitmask" id="bitmask" style="color: inherit; text-decoration: none;"> <h2><code>BitMask</code></h2> </a> <a href="#import-2" id="import-2" style="color: inherit; text-decoration: none;"> <h3>Import</h3> </a> <pre><code class="language-typescript">import {BitMask} from '@toreda/types' </code></pre> <a href="#use-2" id="use-2" style="color: inherit; text-decoration: none;"> <h3>Use</h3> </a> <pre><code class="language-typescript">// Declare and initialize number while also expressing the value's purpose. let mask: BitMask = 0x1; // Becomes more clear when expecting values: function useValue(mask: BitMask): void { ... } // versus: function useValue(mask: number): void { ... } </code></pre> Example <pre><code class="language-typescript">// Expressive Type alias. export type BigId = string; // BigId is an expressive alias replacing the use of 'string' for id's type. It makes no // functional difference, however id types often impose character and length limitations meaning // the value cannot be an arbitrary string. BigId gives the caller context for what string values // are actually valid & accepted. function validateId(id: BigId): void { ... } </code></pre>   <a href="#install" id="install" style="color: inherit; text-decoration: none;"> <h1>Install</h1> </a> <a href="#yarn" id="yarn" style="color: inherit; text-decoration: none;"> <h2>Yarn</h2> </a> <pre><code class="language-bash">$ yarn add @toreda/types --dev </code></pre> <a href="#npm" id="npm" style="color: inherit; text-decoration: none;"> <h2>NPM</h2> </a> <pre><code class="language-bash">$ yarn add @toreda/types --D </code></pre>   <a href="#legal" id="legal" style="color: inherit; text-decoration: none;"> <h1>Legal</h1> </a> <a href="#license" id="license" style="color: inherit; text-decoration: none;"> <h2>License</h2> </a> <a href="LICENSE">MIT</a> © Toreda, Inc. <a href="#copyright" id="copyright" style="color: inherit; text-decoration: none;"> <h2>Copyright</h2> </a> Copyright © 2019 - 2022 Toreda, Inc. All Rights Reserved. <a href="#website" id="website" style="color: inherit; text-decoration: none;"> <h2>Website</h2> </a> Toreda's company website can be found at <a href="https://www.toreda.com">toreda.com</a> </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-type-alias"><a href="modules.html#AAVE" class="tsd-kind-icon">AAVE</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ALGO" class="tsd-kind-icon">ALGO</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ANY" class="tsd-kind-icon">ANY</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ATOM" class="tsd-kind-icon">ATOM</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AVAX" class="tsd-kind-icon">AVAX</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AXS" class="tsd-kind-icon">AXS</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AdaAddr" class="tsd-kind-icon">AdaAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AdaTokenAmt" class="tsd-kind-icon">AdaTokenAmt</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AnyFunc" class="tsd-kind-icon">AnyFunc</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AnyObj" class="tsd-kind-icon">AnyObj</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ApeAddr" class="tsd-kind-icon">ApeAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ApeCoinAmt" class="tsd-kind-icon">ApeCoinAmt</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ArrayFunc" class="tsd-kind-icon">ArrayFunc</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Arrayable" class="tsd-kind-icon">Arrayable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AvaxAddr" class="tsd-kind-icon">AvaxAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AvaxTokenAmt" class="tsd-kind-icon">AvaxTokenAmt</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Awaited" class="tsd-kind-icon">Awaited</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BAT" class="tsd-kind-icon">BAT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BCN" class="tsd-kind-icon">BCN</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BTM" class="tsd-kind-icon">BTM</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BTT" class="tsd-kind-icon">BTT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BUSD" class="tsd-kind-icon">BUSD</a></li><li class="tsd-kind-interface"><a href="interfaces/BaseObject.html" class="tsd-kind-icon">BaseObject</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BchAddr" class="tsd-kind-icon">BchAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BchTokenAmt" class="tsd-kind-icon">BchTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BitField" class="tsd-kind-icon">BitField</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BitMask" class="tsd-kind-icon">BitMask</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Bits" class="tsd-kind-icon">Bits</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BnbAddr" class="tsd-kind-icon">BnbAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BnbTokenAmt" class="tsd-kind-icon">BnbTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Bps" class="tsd-kind-icon">Bps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BscAddr" class="tsd-kind-icon">BscAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BtcAddr" class="tsd-kind-icon">BtcAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BtcCoinAmt" class="tsd-kind-icon">BtcCoinAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Bytes" class="tsd-kind-icon">Bytes</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CAKE" class="tsd-kind-icon">CAKE</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CDAI" class="tsd-kind-icon">CDAI</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CELO" class="tsd-kind-icon">CELO</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CUSDC" class="tsd-kind-icon">CUSDC</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Centimeters" class="tsd-kind-icon">Centimeters</a></li><li class="tsd-kind-interface"><a href="interfaces/Cleanable.html" class="tsd-kind-icon">Cleanable</a></li><li class="tsd-kind-interface"><a href="interfaces/Clearable.html" class="tsd-kind-icon">Clearable</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Closeable.html" class="tsd-kind-icon">Closeable</a></li><li class="tsd-kind-interface"><a href="interfaces/CloseableOutcome.html" class="tsd-kind-icon">CloseableOutcome</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CoinAmt" class="tsd-kind-icon">CoinAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Coins" class="tsd-kind-icon">Coins</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Constructor" class="tsd-kind-icon">Constructor</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DAI" class="tsd-kind-icon">DAI</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DASH" class="tsd-kind-icon">DASH</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DGB" class="tsd-kind-icon">DGB</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DOT" class="tsd-kind-icon">DOT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Data" class="tsd-kind-icon">Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Decimeters" class="tsd-kind-icon">Decimeters</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepExpand" class="tsd-kind-icon">DeepExpand</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepPartial" class="tsd-kind-icon">DeepPartial</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepRequired" class="tsd-kind-icon">DeepRequired</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Degrees" class="tsd-kind-icon">Degrees</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Depromisify" class="tsd-kind-icon">Depromisify</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DogeAddr" class="tsd-kind-icon">DogeAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DogeTokenAmt" class="tsd-kind-icon">DogeTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ENJ" class="tsd-kind-icon">ENJ</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EOS" class="tsd-kind-icon">EOS</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EthAddr" class="tsd-kind-icon">EthAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EthTokenAmt" class="tsd-kind-icon">EthTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Exabytes" class="tsd-kind-icon">Exabytes</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Expand" class="tsd-kind-icon">Expand</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FIL" class="tsd-kind-icon">FIL</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FLO" class="tsd-kind-icon">FLO</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FLOW" class="tsd-kind-icon">FLOW</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FTM" class="tsd-kind-icon">FTM</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FTT" class="tsd-kind-icon">FTT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Farads" class="tsd-kind-icon">Farads</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Feet" class="tsd-kind-icon">Feet</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Femtometers" class="tsd-kind-icon">Femtometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FileSize" class="tsd-kind-icon">FileSize</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FluidOunces" class="tsd-kind-icon">FluidOunces</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GBps" class="tsd-kind-icon">GBps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GRT" class="tsd-kind-icon">GRT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GalaAddr" class="tsd-kind-icon">GalaAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GalaTokenAmt" class="tsd-kind-icon">GalaTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Gallons" class="tsd-kind-icon">Gallons</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Gbps" class="tsd-kind-icon">Gbps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Gigabytes" class="tsd-kind-icon">Gigabytes</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Gigameters" class="tsd-kind-icon">Gigameters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Grams" class="tsd-kind-icon">Grams</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Guarded" class="tsd-kind-icon">Guarded</a></li><li class="tsd-kind-type-alias"><a href="modules.html#HBAR" class="tsd-kind-icon">HBAR</a></li><li class="tsd-kind-type-alias"><a href="modules.html#HashAlg" class="tsd-kind-icon">HashAlg</a></li><li class="tsd-kind-type-alias"><a href="modules.html#HashStr" class="tsd-kind-icon">HashStr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Hashrate" class="tsd-kind-icon">Hashrate</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Hertz" class="tsd-kind-icon">Hertz</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ICP" class="tsd-kind-icon">ICP</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Inches" class="tsd-kind-icon">Inches</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Iterable.html" class="tsd-kind-icon">Iterable</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Itor.html" class="tsd-kind-icon">Itor</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ItorItem.html" class="tsd-kind-icon">ItorItem</a></li><li class="tsd-kind-type-alias"><a href="modules.html#KB" class="tsd-kind-icon">KB</a></li><li class="tsd-kind-type-alias"><a href="modules.html#KBps" class="tsd-kind-icon">KBps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#KSM" class="tsd-kind-icon">KSM</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Katals" class="tsd-kind-icon">Katals</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kbps" class="tsd-kind-icon">Kbps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kelvin" class="tsd-kind-icon">Kelvin</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kilobits" class="tsd-kind-icon">Kilobits</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kilobytes" class="tsd-kind-icon">Kilobytes</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kilograms" class="tsd-kind-icon">Kilograms</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Kilometers" class="tsd-kind-icon">Kilometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LRC" class="tsd-kind-icon">LRC</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LTC" class="tsd-kind-icon">LTC</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LUNA" class="tsd-kind-icon">LUNA</a></li><li class="tsd-kind-class"><a href="classes/LifecycleClient.html" class="tsd-kind-icon">LifecycleClient</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleClientData.html" class="tsd-kind-icon">LifecycleClientData</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleClientDelegate.html" class="tsd-kind-icon">LifecycleClientDelegate</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleClientPhase" class="tsd-kind-icon">LifecycleClientPhase</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleListener" class="tsd-kind-icon">LifecycleListener</a></li><li class="tsd-kind-class"><a href="classes/LifecycleNetworkCnx.html" class="tsd-kind-icon">LifecycleNetworkCnx</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleNetworkCnxData.html" class="tsd-kind-icon">LifecycleNetworkCnxData</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleNetworkCnxDelegate.html" class="tsd-kind-icon">LifecycleNetworkCnxDelegate</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleNetworkCnxPhase" class="tsd-kind-icon">LifecycleNetworkCnxPhase</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecyclePhaseId" class="tsd-kind-icon">LifecyclePhaseId</a></li><li class="tsd-kind-class"><a href="classes/LifecycleServer.html" class="tsd-kind-icon">LifecycleServer</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleServerData.html" class="tsd-kind-icon">LifecycleServerData</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleServerDelegate.html" class="tsd-kind-icon">LifecycleServerDelegate</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleServerPhase" class="tsd-kind-icon">LifecycleServerPhase</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LinkAddr" class="tsd-kind-icon">LinkAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LinkTokenAmt" class="tsd-kind-icon">LinkTokenAmt</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#LiteralToPrimitive" class="tsd-kind-icon">LiteralToPrimitive</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Liters" class="tsd-kind-icon">Liters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Lumens" class="tsd-kind-icon">Lumens</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MANA" class="tsd-kind-icon">MANA</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MBps" class="tsd-kind-icon">MBps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MKR" class="tsd-kind-icon">MKR</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MaticAddr" class="tsd-kind-icon">MaticAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MaticTokenAmt" class="tsd-kind-icon">MaticTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Mbps" class="tsd-kind-icon">Mbps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Megabytes" class="tsd-kind-icon">Megabytes</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Megameters" class="tsd-kind-icon">Megameters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Meters" class="tsd-kind-icon">Meters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Micrometers" class="tsd-kind-icon">Micrometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Miles" class="tsd-kind-icon">Miles</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Millimeters" class="tsd-kind-icon">Millimeters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Nanometers" class="tsd-kind-icon">Nanometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NearAddr" class="tsd-kind-icon">NearAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NearTokenAmt" class="tsd-kind-icon">NearTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NetworkCnxId" class="tsd-kind-icon">NetworkCnxId</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Newtons" class="tsd-kind-icon">Newtons</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NexoAddr" class="tsd-kind-icon">NexoAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NexoTokenAmt" class="tsd-kind-icon">NexoTokenAmt</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#NullOrUndefined" class="tsd-kind-icon">NullOrUndefined</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Nullable" class="tsd-kind-icon">Nullable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Ohms" class="tsd-kind-icon">Ohms</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Optional" class="tsd-kind-icon">Optional</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Ounces" class="tsd-kind-icon">Ounces</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PBps" class="tsd-kind-icon">PBps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Pascals" class="tsd-kind-icon">Pascals</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Pbps" class="tsd-kind-icon">Pbps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Picometers" class="tsd-kind-icon">Picometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Primitive" class="tsd-kind-icon">Primitive</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PrimitiveOrConstructor" class="tsd-kind-icon">PrimitiveOrConstructor</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PrivateKey" class="tsd-kind-icon">PrivateKey</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Promisable" class="tsd-kind-icon">Promisable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PublicKey" class="tsd-kind-icon">PublicKey</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RSI" class="tsd-kind-icon">RSI</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Radians" class="tsd-kind-icon">Radians</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Records.html" class="tsd-kind-icon">Records</a></li><li class="tsd-kind-interface"><a href="interfaces/Resettable.html" class="tsd-kind-icon">Resettable</a></li><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Runnable.html" class="tsd-kind-icon">Runnable</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RunnableOutcome.html" class="tsd-kind-icon">RunnableOutcome</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RunnableTask" class="tsd-kind-icon">RunnableTask</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RunnableTaskSync" class="tsd-kind-icon">RunnableTaskSync</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RvnAddr" class="tsd-kind-icon">RvnAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RvnTokenAmt" class="tsd-kind-icon">RvnTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SAND" class="tsd-kind-icon">SAND</a></li><li class="tsd-kind-type-alias"><a href="modules.html#STX" class="tsd-kind-icon">STX</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SYS" class="tsd-kind-icon">SYS</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Serializable.html" class="tsd-kind-icon">Serializable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ShibAddr" class="tsd-kind-icon">ShibAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ShibTokenAmt" class="tsd-kind-icon">ShibTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Sieverts" class="tsd-kind-icon">Sieverts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SolAddr" class="tsd-kind-icon">SolAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SolTokenAmt" class="tsd-kind-icon">SolTokenAmt</a></li><li class="tsd-kind-interface"><a href="interfaces/Stringable.html" class="tsd-kind-icon">Stringable</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TB" class="tsd-kind-icon">TB</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TBps" class="tsd-kind-icon">TBps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#THETA" class="tsd-kind-icon">THETA</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TUSD" class="tsd-kind-icon">TUSD</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Tag" class="tsd-kind-icon">Tag</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Tbps" class="tsd-kind-icon">Tbps</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Terabits" class="tsd-kind-icon">Terabits</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Terabytes" class="tsd-kind-icon">Terabytes</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Terameters" class="tsd-kind-icon">Terameters</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenAmt" class="tsd-kind-icon">TokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenSymbol" class="tsd-kind-icon">TokenSymbol</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Tokens" class="tsd-kind-icon">Tokens</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TrxAddr" class="tsd-kind-icon">TrxAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TrxTokenAmt" class="tsd-kind-icon">TrxTokenAmt</a></li><li class="tsd-kind-interface"><a href="interfaces/TypeMap.html" class="tsd-kind-icon">TypeMap</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UNI" class="tsd-kind-icon">UNI</a></li><li class="tsd-kind-type-alias"><a href="modules.html#USDC" class="tsd-kind-icon">USDC</a></li><li class="tsd-kind-type-alias"><a href="modules.html#USDT" class="tsd-kind-icon">USDT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#VET" class="tsd-kind-icon">VET</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Visitor" class="tsd-kind-icon">Visitor</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WBTC" class="tsd-kind-icon">WBTC</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WETH" class="tsd-kind-icon">WETH</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Watts" class="tsd-kind-icon">Watts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WavesAddr" class="tsd-kind-icon">WavesAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WavesTokenAmt" class="tsd-kind-icon">WavesTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XRD" class="tsd-kind-icon">XRD</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XTZ" class="tsd-kind-icon">XTZ</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XVG" class="tsd-kind-icon">XVG</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XlmAddr" class="tsd-kind-icon">XlmAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XlmTokenAmt" class="tsd-kind-icon">XlmTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XmrAddr" class="tsd-kind-icon">XmrAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XmrTokenAmt" class="tsd-kind-icon">XmrTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XrpAddr" class="tsd-kind-icon">XrpAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XrpTokenAmt" class="tsd-kind-icon">XrpTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Yards" class="tsd-kind-icon">Yards</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZecAddr" class="tsd-kind-icon">ZecAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZecTokenAmt" class="tsd-kind-icon">ZecTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZilAddr" class="tsd-kind-icon">ZilAddr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZilTokenAmt" class="tsd-kind-icon">ZilTokenAmt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#bps" class="tsd-kind-icon">bps</a></li><li class="tsd-kind-variable"><a href="modules.html#lifecycleClientPhases" class="tsd-kind-icon">lifecycleClientPhases</a></li><li class="tsd-kind-function"><a href="modules.html#lifecycleForEach" class="tsd-kind-icon">lifecycleForEach</a></li><li class="tsd-kind-function"><a href="modules.html#lifecyclePhase" class="tsd-kind-icon">lifecyclePhase</a></li><li class="tsd-kind-function"><a href="modules.html#lifecyclePhaseListenerName" class="tsd-kind-icon">lifecyclePhaseListenerName</a></li><li class="tsd-kind-variable"><a href="modules.html#lifecycleServerPhases" class="tsd-kind-icon">lifecycleServerPhases</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-constructor tsd-parent-kind-class">Constructor</li><li class="tsd-kind-property tsd-parent-kind-class">Property</li><li class="tsd-kind-method tsd-parent-kind-class">Method</li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface">Property</li><li class="tsd-kind-method tsd-parent-kind-interface">Method</li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private">Private property</li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private">Private method</li></ul></div><h2>Settings</h2>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></footer><div class="container tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>