@toreda/types
Version:
Common mappings, aliases, and types used in Toreda TypeScript packages.
25 lines • 317 kB
HTML
<!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"><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></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"><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 "><section class="tsd-index-section"><h3>Type aliases Alias</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#ANY" class="tsd-kind-icon">ANY</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Collections</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#ArrayFunc" class="tsd-kind-icon">Array<wbr/>Func</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AnyFunc" class="tsd-kind-icon">Any<wbr/>Func</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#AnyObj" class="tsd-kind-icon">Any<wbr/>Obj</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 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#HashAlg" class="tsd-kind-icon">Hash<wbr/>Alg</a></li><li class="tsd-kind-type-alias"><a href="modules.html#HashStr" class="tsd-kind-icon">Hash<wbr/>Str</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#PrivateKey" class="tsd-kind-icon">Private<wbr/>Key</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PublicKey" class="tsd-kind-icon">Public<wbr/>Key</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Tag" class="tsd-kind-icon">Tag</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Cryptocurrencies</h3><ul class="tsd-index-list"><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#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">Ada<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AdaTokenAmt" class="tsd-kind-icon">Ada<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ApeAddr" class="tsd-kind-icon">Ape<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ApeCoinAmt" class="tsd-kind-icon">Ape<wbr/>Coin<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AvaxAddr" class="tsd-kind-icon">Avax<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#AvaxTokenAmt" class="tsd-kind-icon">Avax<wbr/>Token<wbr/>Amt</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-type-alias"><a href="modules.html#BchAddr" class="tsd-kind-icon">Bch<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BchTokenAmt" class="tsd-kind-icon">Bch<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BnbAddr" class="tsd-kind-icon">Bnb<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BnbTokenAmt" class="tsd-kind-icon">Bnb<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BscAddr" class="tsd-kind-icon">Bsc<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BtcAddr" class="tsd-kind-icon">Btc<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BtcCoinAmt" class="tsd-kind-icon">Btc<wbr/>Coin<wbr/>Amt</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#CoinAmt" class="tsd-kind-icon">Coin<wbr/>Amt</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"><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#DogeAddr" class="tsd-kind-icon">Doge<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DogeTokenAmt" class="tsd-kind-icon">Doge<wbr/>Token<wbr/>Amt</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">Eth<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#EthTokenAmt" class="tsd-kind-icon">Eth<wbr/>Token<wbr/>Amt</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#GRT" class="tsd-kind-icon">GRT</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GalaAddr" class="tsd-kind-icon">Gala<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GalaTokenAmt" class="tsd-kind-icon">Gala<wbr/>Token<wbr/>Amt</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#Hashrate" class="tsd-kind-icon">Hashrate</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#KSM" class="tsd-kind-icon">KSM</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-type-alias"><a href="modules.html#LinkAddr" class="tsd-kind-icon">Link<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LinkTokenAmt" class="tsd-kind-icon">Link<wbr/>Token<wbr/>Amt</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#MKR" class="tsd-kind-icon">MKR</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MaticAddr" class="tsd-kind-icon">Matic<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MaticTokenAmt" class="tsd-kind-icon">Matic<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NearAddr" class="tsd-kind-icon">Near<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NearTokenAmt" class="tsd-kind-icon">Near<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NexoAddr" class="tsd-kind-icon">Nexo<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NexoTokenAmt" class="tsd-kind-icon">Nexo<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RvnAddr" class="tsd-kind-icon">Rvn<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RvnTokenAmt" class="tsd-kind-icon">Rvn<wbr/>Token<wbr/>Amt</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-type-alias"><a href="modules.html#ShibAddr" class="tsd-kind-icon">Shib<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ShibTokenAmt" class="tsd-kind-icon">Shib<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SolAddr" class="tsd-kind-icon">Sol<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SolTokenAmt" class="tsd-kind-icon">Sol<wbr/>Token<wbr/>Amt</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#TokenAmt" class="tsd-kind-icon">Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenSymbol" class="tsd-kind-icon">Token<wbr/>Symbol</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">Trx<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TrxTokenAmt" class="tsd-kind-icon">Trx<wbr/>Token<wbr/>Amt</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"><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#WavesAddr" class="tsd-kind-icon">Waves<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WavesTokenAmt" class="tsd-kind-icon">Waves<wbr/>Token<wbr/>Amt</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">Xlm<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XlmTokenAmt" class="tsd-kind-icon">Xlm<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XmrAddr" class="tsd-kind-icon">Xmr<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XmrTokenAmt" class="tsd-kind-icon">Xmr<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XrpAddr" class="tsd-kind-icon">Xrp<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#XrpTokenAmt" class="tsd-kind-icon">Xrp<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZecAddr" class="tsd-kind-icon">Zec<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZecTokenAmt" class="tsd-kind-icon">Zec<wbr/>Token<wbr/>Amt</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZilAddr" class="tsd-kind-icon">Zil<wbr/>Addr</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ZilTokenAmt" class="tsd-kind-icon">Zil<wbr/>Token<wbr/>Amt</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Data Types</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#BitField" class="tsd-kind-icon">Bit<wbr/>Field</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BitMask" class="tsd-kind-icon">Bit<wbr/>Mask</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FileSize" class="tsd-kind-icon">File<wbr/>Size</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Data Units</h3><ul class="tsd-index-list"><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#Bytes" class="tsd-kind-icon">Bytes</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"><a href="modules.html#Gigabytes" class="tsd-kind-icon">Gigabytes</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#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#Megabytes" class="tsd-kind-icon">Megabytes</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#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></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Data-rate Units</h3><ul class="tsd-index-list"><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#GBps" class="tsd-kind-icon">GBps</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#KBps" class="tsd-kind-icon">KBps</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#MBps" class="tsd-kind-icon">MBps</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#PBps" class="tsd-kind-icon">PBps</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#TBps" class="tsd-kind-icon">TBps</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#bps" class="tsd-kind-icon">bps</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Imperial Units</h3><ul class="tsd-index-list"><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#FluidOunces" class="tsd-kind-icon">Fluid<wbr/>Ounces</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#Grams" class="tsd-kind-icon">Grams</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Inches" class="tsd-kind-icon">Inches</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#Ounces" class="tsd-kind-icon">Ounces</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#Yards" class="tsd-kind-icon">Yards</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Units of Measurement (Metric)</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#Centimeters" class="tsd-kind-icon">Centimeters</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"><a href="modules.html#Femtometers" class="tsd-kind-icon">Femtometers</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#Kilometers" class="tsd-kind-icon">Kilometers</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#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#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#Picometers" class="tsd-kind-icon">Picometers</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Terameters" class="tsd-kind-icon">Terameters</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Expressive Types - Units of Measurement (Scientific)</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#Degrees" class="tsd-kind-icon">Degrees</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#Hertz" class="tsd-kind-icon">Hertz</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#Kelvin" class="tsd-kind-icon">Kelvin</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#Lumens" class="tsd-kind-icon">Lumens</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#Ohms" class="tsd-kind-icon">Ohms</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#Radians" class="tsd-kind-icon">Radians</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#Watts" class="tsd-kind-icon">Watts</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Lifecycle</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleClientPhase" class="tsd-kind-icon">Lifecycle<wbr/>Client<wbr/>Phase</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleListener" class="tsd-kind-icon">Lifecycle<wbr/>Listener</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleNetworkCnxPhase" class="tsd-kind-icon">Lifecycle<wbr/>Network<wbr/>Cnx<wbr/>Phase</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecyclePhaseId" class="tsd-kind-icon">Lifecycle<wbr/>Phase<wbr/>Id</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LifecycleServerPhase" class="tsd-kind-icon">Lifecycle<wbr/>Server<wbr/>Phase</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Network Connections</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#NetworkCnxId" class="tsd-kind-icon">Network<wbr/>Cnx<wbr/>Id</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Object API</h3><ul class="tsd-index-list"><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 tsd-has-type-parameter"><a href="modules.html#Awaited" class="tsd-kind-icon">Awaited</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepExpand" class="tsd-kind-icon">Deep<wbr/>Expand</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepPartial" class="tsd-kind-icon">Deep<wbr/>Partial</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#DeepRequired" class="tsd-kind-icon">Deep<wbr/>Required</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 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#Primitive" class="tsd-kind-icon">Primitive</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 tsd-has-type-parameter"><a href="modules.html#Visitor" class="tsd-kind-icon">Visitor</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Runnable</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RunnableTask" class="tsd-kind-icon">Runnable<wbr/>Task</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#RunnableTaskSync" class="tsd-kind-icon">Runnable<wbr/>Task<wbr/>Sync</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Signatures</h3><ul class="tsd-index-list"><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 tsd-has-type-parameter"><a href="modules.html#NullOrUndefined" class="tsd-kind-icon">Null<wbr/>Or<wbr/>Undefined</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PrimitiveOrConstructor" class="tsd-kind-icon">Primitive<wbr/>Or<wbr/>Constructor</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Type Guards</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#Guarded" class="tsd-kind-icon">Guarded</a></li></ul></section><section class="tsd-index-section"><h3>Type aliases Type Mapping</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#LiteralToPrimitive" class="tsd-kind-icon">Literal<wbr/>To<wbr/>Primitive</a></li></ul></section></section><section class="tsd-index-section "><section class="tsd-index-section"><h3>Interfaces Base</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/BaseObject.html" class="tsd-kind-icon">Base<wbr/>Object</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Closeable</h3><ul class="tsd-index-list"><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">Closeable<wbr/>Outcome</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Collections</h3><ul class="tsd-index-list"><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">Itor<wbr/>Item</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Serializable.html" class="tsd-kind-icon">Serializable</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Data</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Records.html" class="tsd-kind-icon">Records</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Lifecycle</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/LifecycleClientData.html" class="tsd-kind-icon">Lifecycle<wbr/>Client<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleClientDelegate.html" class="tsd-kind-icon">Lifecycle<wbr/>Client<wbr/>Delegate</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleNetworkCnxData.html" class="tsd-kind-icon">Lifecycle<wbr/>Network<wbr/>Cnx<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleNetworkCnxDelegate.html" class="tsd-kind-icon">Lifecycle<wbr/>Network<wbr/>Cnx<wbr/>Delegate</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleServerData.html" class="tsd-kind-icon">Lifecycle<wbr/>Server<wbr/>Data</a></li><li class="tsd-kind-interface"><a href="interfaces/LifecycleServerDelegate.html" class="tsd-kind-icon">Lifecycle<wbr/>Server<wbr/>Delegate</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Object API</h3><ul class="tsd-index-list"><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"><a href="interfaces/Resettable.html" class="tsd-kind-icon">Resettable</a></li><li class="tsd-kind-interface"><a href="interfaces/Stringable.html" class="tsd-kind-icon">Stringable</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Runnable</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/RunnableOutcome.html" class="tsd-kind-icon">Runnable<wbr/>Outcome</a></li></ul></section><section class="tsd-index-section"><h3>Interfaces Type Mapping</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/TypeMap.html" class="tsd-kind-icon">Type<wbr/>Map</a></li></ul></section></section><section class="tsd-index-section "><section class="tsd-index-section"><h3>Classes Lifecycle</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/LifecycleClient.html" class="tsd-kind-icon">Lifecycle<wbr/>Client</a></li><li class="tsd-kind-class"><a href="classes/LifecycleNetworkCnx.html" class="tsd-kind-icon">Lifecycle<wbr/>Network<wbr/>Cnx</a></li><li class="tsd-kind-class"><a href="classes/LifecycleServer.html" class="tsd-kind-icon">Lifecycle<wbr/>Server</a></li></ul></section><section class="tsd-index-section"><h3>Classes Runnable</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Runnable.html" class="tsd-kind-icon">Runnable</a></li></ul></section></section><section class="tsd-index-section "><section class="tsd-index-section"><h3>Variables Lifecycle</h3><ul class="tsd-index-list"><li class="tsd-kind-variable"><a href="modules.html#lifecycleClientPhases" class="tsd-kind-icon">lifecycle<wbr/>Client<wbr/>Phases</a></li><li class="tsd-kind-variable"><a href="modules.html#lifecycleServerPhases" class="tsd-kind-icon">lifecycle<wbr/>Server<wbr/>Phases</a></li></ul></section></section><section class="tsd-index-section "><section class="tsd-index-section"><h3>Functions Lifecycle</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#lifecycleForEach" class="tsd-kind-icon">lifecycle<wbr/>For<wbr/>Each</a></li><li class="tsd-kind-function"><a href="modules.html#lifecyclePhase" class="tsd-kind-icon">lifecycle<wbr/>Phase</a></li><li class="tsd-kind-function"><a href="modules.html#lifecyclePhaseListenerName" class="tsd-kind-icon">lifecycle<wbr/>Phase<wbr/>Listener<wbr/>Name</a></li></ul></section></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Alias Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ANY" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ANY<a href="#ANY" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ANY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/any.ts#L34">any.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for 'any'. Toreda types avoid 'any' whenever possible. Accurate types,
generics, or even unknown are always preferred. In rare cases where 'any' is necessary,
this alias avoids compiler warnings and demonstrates 'any' usage is intentional.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Collections Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="ArrayFunc" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Array<wbr/>Func<a href="#ArrayFunc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Array<wbr/>Func<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, ndx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/array/func.ts#L31">array/func.ts:31</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li><li><h4>U</h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, ndx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Array callback type signature used by forEach.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>element: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>ndx: <span class="tsd-signature-type">number</span></h5></li><li><h5>arr: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Expressive Types Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="AnyFunc" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Any<wbr/>Func<a href="#AnyFunc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Any<wbr/>Func<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><a href="modules.html#ANY" class="tsd-signature-type" data-tsd-kind="Type alias">ANY</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/any/func.ts#L33">any/func.ts:33</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">unknown</span></h4></li></ul><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><a href="modules.html#ANY" class="tsd-signature-type" data-tsd-kind="Type alias">ANY</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for basic sync or async functions.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <a href="modules.html#ANY" class="tsd-signature-type" data-tsd-kind="Type alias">ANY</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="AnyObj" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Any<wbr/>Obj<a href="#AnyObj" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Any<wbr/>Obj<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/any/obj.ts#L31">any/obj.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type alias for simple objects.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">unknown</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Data" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Data<a href="#Data" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/data.ts#L31">data.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Describes dictionary objects mapping strings to primitive data.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="Expand" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Expand<a href="#Expand" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Expand<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">infer </span> obj<span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type">obj</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">obj</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">key</span><span class="tsd-signature-symbol">]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">never</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/expand.ts#L29">expand.ts:29</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="HashAlg" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Hash<wbr/>Alg<a href="#HashAlg" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Hash<wbr/>Alg<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/toreda/types/blob/51936b5/src/hash/alg.ts#L32">hash/alg.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Unique identifier for a specific hashing algorithm. Commonly used to identify which algorithm
was used when more than one option is available.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="HashStr" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Hash<wbr/>Str<a href="#HashStr" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Hash<wbr/>Str<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/toreda/types/blob/51936b5/src/hash/str.ts#L31">hash/str.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Expressive type for strings produced by hashing algorithms.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-has-type-parameter"><a id="Optional" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Optional<a href="#Optional" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Optional<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">InterfaceT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ExceptKey</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">InterfaceT</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ExceptKey</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">InterfaceT</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/51936b5/src/optional.ts#L32">optional.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Make all top-level <code>InterfaceT</code> properties optional except the key name or key names
provided in <code>ExceptKey</code>.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>InterfaceT</h4></li><li><h4>ExceptKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">InterfaceT</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="PrivateKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Private<wbr/>Key<a href="#PrivateKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Private<wbr/>Key<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/toreda/types/blob/51936b5/src/private/key.ts#L33">private/key.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Identifies private key data. Does not describe data, data length, or algorithm used.
Only identifies that data is a public key. Additional fields may further describe details
about key.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="PublicKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Public<wbr/>Key<a