Skip to content

Commit f8aadbb

Browse files
mbrichmbrich
committed
Added additional types for metric units, imperial units, scientific units, and cryptocurrencies.
1 parent a463b08 commit f8aadbb

169 files changed

Lines changed: 5227 additions & 89 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CHANGELOG.md‎

Lines changed: 162 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,166 @@
11

22
# [Unreleased]
33

4+
# [2.8.0] - 2022-02-22
5+
6+
## New Types
7+
8+
### Cryptocurrency Units
9+
* `AAVE`
10+
* `ADA`
11+
* `ALGO`
12+
* `APE`
13+
* `ATOM`
14+
* `AVAX`
15+
* `AXS`
16+
* `BCH`
17+
* `BCN`
18+
* `BNB`
19+
* `BTC`
20+
* `BTM`
21+
* `BTM`
22+
* `BTT`
23+
* `BTT`
24+
* `BUSD`
25+
* `CAKE`
26+
* `CDAI`
27+
* `CEL`
28+
* `CELO`
29+
* `Coins`
30+
* `CUSDC`
31+
* `DAI`
32+
* `DASH`
33+
* `DGB`
34+
* `DOGE`
35+
* `DOT`
36+
* `ENJ`
37+
* `EOS`
38+
* `ETH`
39+
* `FIL`
40+
* `FLO`
41+
* `FLOW`
42+
* `FTM`
43+
* `FTX`
44+
* `FTX`
45+
* `GALA`
46+
* `GRT`
47+
* `Hashrate`
48+
* `HBAR`
49+
* `KCS`
50+
* `KSM`
51+
* `LINK`
52+
* `LRC`
53+
* `LTC`
54+
* `LUNA`
55+
* `MANA`
56+
* `MATIC`
57+
* `MKR`
58+
* `NEAR`
59+
* `NEXO`
60+
* `RVN`
61+
* `SAND`
62+
* `SHIB`
63+
* `SOL`
64+
* `STX`
65+
* `SYS`
66+
* `Tokens`
67+
* `TRX`
68+
* `TUSD`
69+
* `UNI`
70+
* `USDC`
71+
* `USDT`
72+
* `VET`
73+
* `VTC`
74+
* `WAVES`
75+
* `WBTC`
76+
* `WETH`
77+
* `ZEC`
78+
* `XLM`
79+
* `XMR`
80+
* `XRD`
81+
* `XRP`
82+
* `XTZ`
83+
* `XVG`
84+
* `ZEN`
85+
* `ZIL`
86+
* `ICP`
87+
88+
### Scientific Units
89+
* `Amperes`
90+
* `Degrees`
91+
* `Katals`
92+
* `Farads`
93+
* `Hertz`
94+
* `Joules`
95+
* `Kelvin`
96+
* `Kilograms`
97+
* `Mole`
98+
* `Newtons`
99+
* `Ohms`
100+
* `Radians`
101+
* `Sieverts`
102+
* `Telsas`
103+
104+
### Data Units
105+
* `Bits`
106+
* `Bytes`
107+
* `Kilobytes`
108+
* `Kilobits`
109+
* `Megabytes`
110+
* `Gigabytes`
111+
* `Petabytes`
112+
* `Megabits`
113+
* `Gigabits`
114+
* `Exabytes`
115+
* `Terabytes`
116+
* `Terabits`
117+
118+
### Data-rate Units
119+
* `bps`
120+
* `Bps`
121+
* `Mbps`
122+
* `MBps`
123+
* `Gbps`
124+
* `GBps`
125+
* `Tbps`
126+
* `TBps`
127+
* `Pbps`
128+
* `PBps`
129+
130+
### Size and Distance
131+
#### Imperial
132+
* `Feet`
133+
* `FluidOunces`
134+
* `Gallons`
135+
* `Grams`
136+
* `Inches`
137+
* `Miles`
138+
* `Ounces`
139+
* `Pounds`
140+
* `Yards`
141+
142+
#### Metric
143+
* `Centimeters`
144+
* `Decimeters`
145+
* `Femtometers`
146+
* `Gigameters`
147+
* `Kilometers`
148+
* `Megameters`
149+
* `Meters`
150+
* `Micrometers`
151+
* `Micrometers`
152+
* `Millimeters`
153+
* `Nanometers`
154+
* `Picometers`
155+
* `Terameters`
156+
157+
## New Types
158+
* `HashStr` to express hash string values.
159+
* `HashAlg` to express unique identifiers for hashing algorithms, e.g. `sha256`. Does not comfort to a specific format e.g. `sha256` vs `sha-256`, only that the stored value uniquely identifies a hashing algorithm.
160+
* `FileSize` to express file sizes in bytes or other units.
161+
* `PublicKey` to identify properties containing public key data, but does not describe algorithm, length, or other specific properties about the key.
162+
* `PrivateKey` to identify properties containing private key data, but does not describe algorithm, length, or other specific properties about the key.
163+
4164
# [2.7.0] - 2022-02-21
5165

6166
## Added
@@ -73,7 +233,8 @@
73233
* No changelog for release.
74234

75235

76-
[Unreleased]: https://github.com/toreda/types/releases/compare/v1.2.2...HEAD
236+
[Unreleased]: https://github.com/toreda/types/releases/compare/v2.8.0...HEAD
237+
[2.7.0]: https://github.com/toreda/types/releases/compare/v2.7.0...v2.8.0
77238
[2.7.0]: https://github.com/toreda/types/releases/compare/v2.6.0...v2.7.0
78239
[2.6.0]: https://github.com/toreda/types/releases/compare/v2.5.0...v2.6.0
79240
[2.5.0]: https://github.com/toreda/types/releases/compare/v2.4.0...v2.5.0

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Improve readability, reduce redundancy. Functional & Expressive Types used i
4242
- [Legal](#legal)
4343
- [License](#license)
4444
- [Copyright](#copyright)
45+
- [Website](#website)
4546

4647
 
4748

@@ -239,4 +240,6 @@ $ yarn add @toreda/types --D
239240
## Copyright
240241
Copyright © 2019 - 2022 Toreda, Inc. All Rights Reserved.
241242

242-
https://www.toreda.com
243+
244+
## Website
245+
Toreda's company website can be found at [toreda.com](https://www.toreda.com)

‎docs/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/LifecycleClient.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/classes/LifecycleServer.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 8 additions & 18 deletions
Large diffs are not rendered by default.

‎docs/interfaces/Cleanable.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cleanable | @toreda/types</title><meta name="description" content="Documentation for @toreda/types"/><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</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@toreda/types</a></li><li><a href="Cleanable.html">Cleanable</a></li></ul><h1>Interface Cleanable</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2+
<p>Implementer offers a <code>clean</code> method to clean internal object state or remove
3+
temporary &amp; cached data.</p>
4+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Cleanable</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Cleanable.html#clean" class="tsd-kind-icon">clean</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="clean" class="tsd-anchor"></a><h3>clean</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">clean<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in cleanable.ts:33</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Cleanable.html" class="tsd-kind-icon">Cleanable</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Cleanable.html#clean" class="tsd-kind-icon">clean</a></li></ul></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"><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></ul><ul class="tsd-legend"><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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>

‎docs/interfaces/Clearable.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Clearable | @toreda/types</title><meta name="description" content="Documentation for @toreda/types"/><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</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@toreda/types</a></li><li><a href="Clearable.html">Clearable</a></li></ul><h1>Interface Clearable</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
22
<p>Implementer offers a <code>clear</code> method to clear elements.</p>
3-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Clearable</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Clearable.html#clear" class="tsd-kind-icon">clear</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="clear" class="tsd-anchor"></a><h3>clear</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/30263c8/src/clearable.ts#L32">clearable.ts:32</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Clearable.html" class="tsd-kind-icon">Clearable</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Clearable.html#clear" class="tsd-kind-icon">clear</a></li></ul></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"><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></ul><ul class="tsd-legend"><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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>
3+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Clearable</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Clearable.html#clear" class="tsd-kind-icon">clear</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="clear" class="tsd-anchor"></a><h3>clear</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/toreda/types/blob/a463b08/src/clearable.ts#L32">clearable.ts:32</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Clearable.html" class="tsd-kind-icon">Clearable</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Clearable.html#clear" class="tsd-kind-icon">clear</a></li></ul></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"><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></ul><ul class="tsd-legend"><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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>

0 commit comments

Comments
 (0)