@procore/globalization-toolkit 3.0.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.changeset/README.md +8 -0
- package/.changeset/config.json +11 -0
- package/.depcheckrc +1 -4
- package/CHANGELOG.md +4 -8
- package/README.md +40 -46
- package/dist/dateTimes/DateTimeFormatter.d.ts +2 -0
- package/dist/dateTimes/DateTimeFormatter.js +22 -1
- package/dist/dateTimes/DateTimeFormatter.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/docs/assets/highlight.css +23 -16
- package/docs/assets/main.js +4 -3
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +473 -370
- package/docs/classes/CurrencyFormatter.html +25 -172
- package/docs/classes/DateTimeFormatter.html +15 -151
- package/docs/classes/NumberFormatter.html +20 -179
- package/docs/functions/formatCurrency.html +5 -129
- package/docs/functions/formatCurrencyToParts.html +5 -129
- package/docs/functions/formatDateTime.html +5 -129
- package/docs/functions/formatDateTimeToParts.html +5 -129
- package/docs/functions/formatNumber.html +5 -129
- package/docs/functions/formatNumberToParts.html +5 -129
- package/docs/functions/getCurrencySeparators.html +4 -125
- package/docs/functions/getDatePartsWithPlaceholders.html +5 -129
- package/docs/functions/getDatePlaceholder.html +5 -129
- package/docs/functions/getNumberSeparators.html +4 -125
- package/docs/functions/getStartDayOfTheWeek.html +4 -125
- package/docs/functions/getSupportedCurrencies.html +4 -0
- package/docs/functions/parseCurrency.html +5 -129
- package/docs/functions/parseNumber.html +5 -129
- package/docs/index.html +74 -261
- package/docs/interfaces/CurrencyOptions.html +8 -108
- package/docs/interfaces/DateTimeOptionsBasic.html +4 -101
- package/docs/interfaces/DateTimeOptionsComponentsAll.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsHourMinute.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsHourMinuteSecond.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsMonthDay.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsWeekdayYearMonthDay.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsYearMonth.html +14 -158
- package/docs/interfaces/DateTimeOptionsComponentsYearMonthDay.html +14 -158
- package/docs/interfaces/DateTimeOptionsStyle.html +14 -158
- package/docs/interfaces/NumberOptions.html +6 -94
- package/docs/modules.html +66 -186
- package/docs/types/CurrencyDisplay.html +1 -111
- package/docs/types/CurrencySign.html +1 -111
- package/docs/types/DateLabelOptions.html +1 -119
- package/docs/types/DateStyle.html +1 -111
- package/docs/types/DateTimeFormatPart.html +1 -110
- package/docs/types/DateTimeOptions.html +1 -110
- package/docs/types/DateTimeStyle.html +1 -111
- package/docs/types/Day.html +1 -111
- package/docs/types/FormatterOptions.html +1 -115
- package/docs/types/Hour.html +1 -111
- package/docs/types/Locale.html +1 -110
- package/docs/types/Minute.html +1 -111
- package/docs/types/Month.html +1 -111
- package/docs/types/NumberFormatPart.html +1 -110
- package/docs/types/NumericTwoDigit.html +1 -111
- package/docs/types/Percent.html +1 -111
- package/docs/types/Second.html +1 -111
- package/docs/types/Separators.html +1 -117
- package/docs/types/TimeStyle.html +1 -111
- package/docs/types/TimeZoneName.html +1 -111
- package/docs/types/Weekday.html +1 -111
- package/docs/types/Year.html +1 -111
- package/docs/variables/CurrencyDisplay-1.html +1 -122
- package/docs/variables/CurrencySign-1.html +1 -118
- package/docs/variables/DateStyle-1.html +1 -122
- package/docs/variables/DateTimeStyle-1.html +1 -122
- package/docs/variables/Day-1.html +1 -118
- package/docs/variables/Hour-1.html +1 -118
- package/docs/variables/Minute-1.html +1 -118
- package/docs/variables/Month-1.html +1 -124
- package/docs/variables/NumericTwoDigit-1.html +1 -118
- package/docs/variables/Percent-1.html +1 -118
- package/docs/variables/Second-1.html +1 -118
- package/docs/variables/TimeStyle-1.html +1 -122
- package/docs/variables/TimeZoneName-1.html +1 -118
- package/docs/variables/Weekday-1.html +1 -120
- package/docs/variables/Year-1.html +1 -118
- package/package.json +8 -44
- package/tsconfig.build.json +0 -1
package/docs/index.html
CHANGED
|
@@ -1,62 +1,24 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@procore/globalization-toolkit</title><meta name="description" content="Documentation for @procore/globalization-toolkit"/><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
-
<div class="tsd-toolbar-contents container">
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base=".">
|
|
4
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
-
<div class="field">
|
|
6
|
-
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
-
<ul class="results">
|
|
8
|
-
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@procore/globalization-toolkit</a></div>
|
|
10
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
-
<div class="container container-main">
|
|
12
|
-
<div class="col-8 col-content">
|
|
13
|
-
<div class="tsd-page-title">
|
|
14
|
-
<h2>@procore/globalization-toolkit</h2></div>
|
|
15
|
-
<div class="tsd-panel tsd-typography">
|
|
16
|
-
<a href="#globalization-toolkit" id="globalization-toolkit" style="color: inherit; text-decoration: none;">
|
|
17
|
-
<h1>globalization-toolkit</h1>
|
|
18
|
-
</a>
|
|
19
|
-
<p>i18n formatting library</p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@procore/globalization-toolkit</title><meta name="description" content="Documentation for @procore/globalization-toolkit"/><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 defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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">@procore/globalization-toolkit</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@procore/globalization-toolkit</h2></div><div class="tsd-panel tsd-typography"><a id="md:globalization-toolkit" class="tsd-anchor"></a><h1><a href="#md:globalization-toolkit">globalization-toolkit</a></h1><p>i18n formatting library</p>
|
|
20
2
|
<p><a href="https://procoretech.slack.com/archives/C037J98SPHD"><img src="https://img.shields.io/badge/Maintainer-team--global--by--design-orange" alt="Maintainer"></a>
|
|
21
3
|
<a href="https://circleci.com/gh/procore/globalization-toolkit/tree/main"><img src="https://circleci.com/gh/procore/globalization-toolkit/tree/main.svg?style=shield&circle-token=2f3787c62ef88e345956761b9d6e243f043a08a7" alt="CircleCI"></a>
|
|
22
4
|
<a href="https://www.npmjs.com/package/@procore/globalization-toolkit"><img src="https://img.shields.io/badge/NPM-%40procore%2Fglobalization--toolkit-blue" alt="NPM"></a></p>
|
|
23
5
|
<p>Before implementing the Globalization Toolkit (GTK), please review the <a href="https://lucid.app/lucidchart/47c65380-9d87-409a-a15e-77c668e4c474/edit?invitationId=inv_abb5b5f8-3d6f-499f-920d-6dc6b7c9734c&page=0_0#">Globalization Toolkit Adoption Diagram</a> to determine the best implementation strategy for you. Continue reading for instructions on direct usage of the GTK. </p>
|
|
24
|
-
|
|
25
|
-
<a href="#engineering-documentation" id="engineering-documentation" style="color: inherit; text-decoration: none;">
|
|
26
|
-
<h2><a href="https://procore.github.io/globalization-toolkit/">Engineering Documentation</a></h2>
|
|
27
|
-
</a>
|
|
28
|
-
<p>The engineering documentation contains technical documentation for the GTK repo. It details classes, types, interfaces, and features. Continue reading for install and usage instructions.
|
|
6
|
+
<a id="md:engineering-documentation" class="tsd-anchor"></a><h2><a href="#md:engineering-documentation"><a href="https://procore.github.io/globalization-toolkit/">Engineering Documentation</a></a></h2><p>The engineering documentation contains technical documentation for the GTK repo. It details classes, types, interfaces, and features. Continue reading for install and usage instructions.
|
|
29
7
|
Further reading on the GTK:</p>
|
|
30
8
|
<ul>
|
|
31
9
|
<li><a href="https://docs.google.com/presentation/d/1FtB2DR5qroKgGcxxWsu5Ac9QHA01I7WM75FUeB67izE/edit?usp=sharing">GTK Adoption Training Presentation</a></li>
|
|
32
10
|
<li><a href="https://github.com/procore/system-design-records/blob/main/lifecycle/2-pilot/internationalization/0002-globalization-toolkit.md">GTK SDR</a></li>
|
|
33
|
-
<li><a href="">GTK FAQ</a
|
|
11
|
+
<li><a href="https://github.com/procore/globalization-toolkit/blob/41ada23bfa8956c68a7c853da70ec11f766b417a/FAQ.md">GTK FAQ</a></li>
|
|
34
12
|
</ul>
|
|
35
|
-
|
|
36
|
-
<
|
|
37
|
-
|
|
38
|
-
</a>
|
|
39
|
-
<p>NPM</p>
|
|
40
|
-
<pre><code class="language-sh"><span class="hl-0">$ </span><span class="hl-1">npm</span><span class="hl-0"> </span><span class="hl-1">i</span><span class="hl-0"> </span><span class="hl-1">--save</span><span class="hl-0"> </span><span class="hl-1">@procore/globalization-toolkit</span>
|
|
41
|
-
</code></pre>
|
|
13
|
+
<a id="md:install" class="tsd-anchor"></a><h2><a href="#md:install">Install</a></h2><p>NPM</p>
|
|
14
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> </span><span class="hl-3">--save</span><span class="hl-1"> </span><span class="hl-2">@procore/globalization-toolkit</span>
|
|
15
|
+
</code><button>Copy</button></pre>
|
|
42
16
|
<p>YARN</p>
|
|
43
|
-
<pre><code class="language-sh"><span class="hl-0"
|
|
44
|
-
</code></pre>
|
|
45
|
-
|
|
46
|
-
<a
|
|
47
|
-
|
|
48
|
-
</a>
|
|
49
|
-
<p>The GTK has 3 available classes: NumberFormatter, DateTimeFormatter, CurrencyFormatter. The structure of the GTK Library allows for instantiation of a formatting class with defined options. The instantiated class gives access to related functions. In addition, the GTK makes the class functions available as stand-alone functions. Below are examples of GTK usage with class formatter and with stand-alone functions. </p>
|
|
50
|
-
|
|
51
|
-
<a href="#a-note-on-locales" id="a-note-on-locales" style="color: inherit; text-decoration: none;">
|
|
52
|
-
<h3>A Note on Locales</h3>
|
|
53
|
-
</a>
|
|
54
|
-
<p>The GTK supports industry standard locale codes. The GTK does NOT support <a href="https://procoretech.atlassian.net/wiki/spaces/PLATFORM/pages/1039111578/Levels+of+Support+for+Locales+Product+Coverage#Custom-Locales">Procore Custom Locales</a>. When implementing the GTK, please sanitize the locale to follow industry standard of 'region-language' like 'en-US'.</p>
|
|
55
|
-
|
|
56
|
-
<a href="#numberformatter-class" id="numberformatter-class" style="color: inherit; text-decoration: none;">
|
|
57
|
-
<h3>NumberFormatter Class</h3>
|
|
58
|
-
</a>
|
|
59
|
-
<p>The GTK <code>NumberFormatter</code> class has the ability to format numbers for a given locale. The <a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter">NumberFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/interfaces/NumberOptions.html">NumberOptions</a> and has 4 available functions: </p>
|
|
17
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">yarn</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">@procore/globalization-toolkit</span>
|
|
18
|
+
</code><button>Copy</button></pre>
|
|
19
|
+
<a id="md:usage" class="tsd-anchor"></a><h2><a href="#md:usage">Usage</a></h2><p>The GTK has 3 available classes: <code>NumberFormatter</code>, <code>DateTimeFormatter</code>, <code>CurrencyFormatter</code>. The structure of the GTK Library allows for instantiation of a formatting class with defined options. The instantiated class gives access to related functions. In addition, the GTK makes the class functions available as stand-alone functions. Below are examples of GTK usage with class formatter and with stand-alone functions. </p>
|
|
20
|
+
<a id="md:a-note-on-locales" class="tsd-anchor"></a><h3><a href="#md:a-note-on-locales">A Note on Locales</a></h3><p>The GTK supports industry standard locale codes. The GTK does NOT support <a href="https://procoretech.atlassian.net/wiki/spaces/PLATFORM/pages/1039111578/Levels+of+Support+for+Locales+Product+Coverage#Custom-Locales">Procore Custom Locales</a>. When implementing the GTK, please sanitize the locale to follow industry standard of 'region-language' like 'en-US'.</p>
|
|
21
|
+
<a id="md:numberformatter-class" class="tsd-anchor"></a><h3><a href="#md:numberformatter-class">NumberFormatter Class</a></h3><p>The GTK <code>NumberFormatter</code> class has the ability to format numbers for a given locale. The <a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter">NumberFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/interfaces/NumberOptions.html">NumberOptions</a> and has 4 available functions: </p>
|
|
60
22
|
<ul>
|
|
61
23
|
<li><code>formatNumber(value: number)</code>, </li>
|
|
62
24
|
<li><code>formatNumberToParts(value: number)</code>, </li>
|
|
@@ -71,29 +33,13 @@ Further reading on the GTK:</p>
|
|
|
71
33
|
<li><code>percent?</code>: 'standard', 'decimal'</li>
|
|
72
34
|
</ul>
|
|
73
35
|
<p>Below code blocks display usage of the NumberFormatter class and available functions. </p>
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
</
|
|
78
|
-
<pre><code class="language-ts"><span class="hl-
|
|
79
|
-
</code></pre>
|
|
80
|
-
|
|
81
|
-
<a href="#parsenumber" id="parsenumber" style="color: inherit; text-decoration: none;">
|
|
82
|
-
<h4><a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#parseNumber">parseNumber()</a></h4>
|
|
83
|
-
</a>
|
|
84
|
-
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">NumberFormatter</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">'@procore/globalization-toolkit'</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">value</span><span class="hl-0"> = </span><span class="hl-1">"123 456 789,12"</span><span class="hl-0">;</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">numberOptions</span><span class="hl-0"> = { </span><span class="hl-3">locale:</span><span class="hl-0"> </span><span class="hl-1">"fr-FR"</span><span class="hl-0"> };</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">formatter</span><span class="hl-0"> = </span><span class="hl-4">new</span><span class="hl-0"> </span><span class="hl-7">NumberFormatter</span><span class="hl-0">(</span><span class="hl-3">numberOptions</span><span class="hl-0">);</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">formatter</span><span class="hl-0">.</span><span class="hl-7">parseNumber</span><span class="hl-0">(</span><span class="hl-3">value</span><span class="hl-0">)); </span><span class="hl-8">// expected output: '123456789.12'</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">formatter</span><span class="hl-0">.</span><span class="hl-7">parseNumber</span><span class="hl-0">(</span><span class="hl-1">"Abcd"</span><span class="hl-0">)); </span><span class="hl-8">// expected output: NaN</span>
|
|
85
|
-
</code></pre>
|
|
86
|
-
|
|
87
|
-
<a href="#getseparators" id="getseparators" style="color: inherit; text-decoration: none;">
|
|
88
|
-
<h4><a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#getNumberSeparators">getSeparators()</a></h4>
|
|
89
|
-
</a>
|
|
90
|
-
<pre><code class="language-ts"><span class="hl-2">import</span><span class="hl-0"> { </span><span class="hl-3">NumberFormatter</span><span class="hl-0"> } </span><span class="hl-2">from</span><span class="hl-0"> </span><span class="hl-1">'@procore/globalization-toolkit'</span><span class="hl-0">;</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">germanNumberOptions</span><span class="hl-0"> = { </span><span class="hl-3">locale:</span><span class="hl-0"> </span><span class="hl-1">"de-DE"</span><span class="hl-0"> };</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">germanFormatter</span><span class="hl-0"> = </span><span class="hl-4">new</span><span class="hl-0"> </span><span class="hl-7">NumberFormatter</span><span class="hl-0">(</span><span class="hl-3">germanNumberOptions</span><span class="hl-0">);</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">germanFormatter</span><span class="hl-0">.</span><span class="hl-7">getSeparators</span><span class="hl-0">()); </span><span class="hl-8">// expected output: { decimal: ",", group: "." }</span><br/><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">usNumberOptions</span><span class="hl-0"> = { </span><span class="hl-3">locale:</span><span class="hl-0"> </span><span class="hl-1">'en-US'</span><span class="hl-0"> };</span><br/><span class="hl-4">const</span><span class="hl-0"> </span><span class="hl-5">formatter</span><span class="hl-0"> = </span><span class="hl-4">new</span><span class="hl-0"> </span><span class="hl-7">NumberFormatter</span><span class="hl-0">(</span><span class="hl-3">usNumberOptions</span><span class="hl-0">);</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">formatter</span><span class="hl-0">.</span><span class="hl-7">getSeparators</span><span class="hl-0">()); </span><span class="hl-8">// expected output: { decimal: ".", group: "," }</span>
|
|
91
|
-
</code></pre>
|
|
92
|
-
|
|
93
|
-
<a href="#numberformatter-functions" id="numberformatter-functions" style="color: inherit; text-decoration: none;">
|
|
94
|
-
<h3>NumberFormatter Functions</h3>
|
|
95
|
-
</a>
|
|
96
|
-
<p>The functions used on the NumberFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
36
|
+
<a id="md:formatnumber-amp-formatnumbertoparts" class="tsd-anchor"></a><h4><a href="#md:formatnumber-amp-formatnumbertoparts"><a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#formatNumber">formatNumber()</a> & <a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#formatNumberToParts">formatNumberToParts()</a></a></h4><pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">NumberFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">numberOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-US"</span><span class="hl-1">, </span><span class="hl-5">minimumFractionDigits:</span><span class="hl-1"> </span><span class="hl-7">3</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">NumberFormatter</span><span class="hl-1">(</span><span class="hl-5">numberOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatNumber</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)) </span><span class="hl-8">// expected output: '1,234.000'</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatNumberToParts</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">))</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * expected output is an array of objects representing the parts of the formatted number:</span><br/><span class="hl-8"> * [</span><br/><span class="hl-8"> * { type: "integer", value: "1", },</span><br/><span class="hl-8"> * { type: "group", value: ",", },</span><br/><span class="hl-8"> * { type: "integer", value: "234", },</span><br/><span class="hl-8"> * { type: "decimal", value: ".", },</span><br/><span class="hl-8"> * { type: "fraction", value: "000", },</span><br/><span class="hl-8"> * ];</span><br/><span class="hl-8"> */</span>
|
|
37
|
+
</code><button>Copy</button></pre>
|
|
38
|
+
<a id="md:parsenumber" class="tsd-anchor"></a><h4><a href="#md:parsenumber"><a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#parseNumber">parseNumber()</a></a></h4><pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">NumberFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-2">"123 456 789,12"</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">numberOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"fr-FR"</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">NumberFormatter</span><span class="hl-1">(</span><span class="hl-5">numberOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">parseNumber</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)); </span><span class="hl-8">// expected output: '123456789.12'</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">parseNumber</span><span class="hl-1">(</span><span class="hl-2">"Abcd"</span><span class="hl-1">)); </span><span class="hl-8">// expected output: NaN</span>
|
|
39
|
+
</code><button>Copy</button></pre>
|
|
40
|
+
<a id="md:getseparators" class="tsd-anchor"></a><h4><a href="#md:getseparators"><a href="https://procore.github.io/globalization-toolkit/classes/NumberFormatter.html#getNumberSeparators">getSeparators()</a></a></h4><pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">NumberFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">germanNumberOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"de-DE"</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">germanFormatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">NumberFormatter</span><span class="hl-1">(</span><span class="hl-5">germanNumberOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">germanFormatter</span><span class="hl-1">.</span><span class="hl-0">getSeparators</span><span class="hl-1">()); </span><span class="hl-8">// expected output: { decimal: ",", group: "." }</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">usNumberOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">'en-US'</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">NumberFormatter</span><span class="hl-1">(</span><span class="hl-5">usNumberOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">getSeparators</span><span class="hl-1">()); </span><span class="hl-8">// expected output: { decimal: ".", group: "," }</span>
|
|
41
|
+
</code><button>Copy</button></pre>
|
|
42
|
+
<a id="md:numberformatter-functions" class="tsd-anchor"></a><h3><a href="#md:numberformatter-functions">NumberFormatter Functions</a></h3><p>The functions used on the NumberFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
97
43
|
<ul>
|
|
98
44
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatNumber.html">formatNumber</a></li>
|
|
99
45
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatNumberToParts.html">formatNumberToParts</a></li>
|
|
@@ -101,18 +47,15 @@ Further reading on the GTK:</p>
|
|
|
101
47
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/getNumberSeparators.html">getNumberSeparators</a></li>
|
|
102
48
|
</ul>
|
|
103
49
|
<p>The example below shows usage of the stand alone function: <code>formatNumber()</code>.</p>
|
|
104
|
-
<pre><code class="language-ts"><span class="hl-
|
|
105
|
-
</code></pre>
|
|
106
|
-
|
|
107
|
-
<a href="#currencyformatter-class" id="currencyformatter-class" style="color: inherit; text-decoration: none;">
|
|
108
|
-
<h3>CurrencyFormatter class</h3>
|
|
109
|
-
</a>
|
|
110
|
-
<p>The GTK CurrencyFormatter class has the ability to format a number with given options. The <a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html">CurrencyFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/interfaces/CurrencyOptions.html">CurrencyOptions</a>.<br>The CurrencyFormatter has 4 available functions: </p>
|
|
50
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">formatNumber</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">numberOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-US"</span><span class="hl-1">, </span><span class="hl-5">minimumFractionDigits:</span><span class="hl-1"> </span><span class="hl-7">3</span><span class="hl-1"> };</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-0">formatNumber</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">, </span><span class="hl-5">numberOptions</span><span class="hl-1">)) </span><span class="hl-8">// expected output: '1,234.000'</span>
|
|
51
|
+
</code><button>Copy</button></pre>
|
|
52
|
+
<a id="md:currencyformatter-class" class="tsd-anchor"></a><h3><a href="#md:currencyformatter-class">CurrencyFormatter class</a></h3><p>The GTK CurrencyFormatter class has the ability to format a number with given options. The <a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html">CurrencyFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/interfaces/CurrencyOptions.html">CurrencyOptions</a>.<br>The CurrencyFormatter has 5 available functions: </p>
|
|
111
53
|
<ul>
|
|
112
54
|
<li><code>formatCurrency(value: number)</code>, </li>
|
|
113
55
|
<li><code>formatCurrencyToParts(value: number)</code></li>
|
|
114
56
|
<li><code>parseCurrency(value: string)</code> </li>
|
|
115
57
|
<li><code>getCurrencySeparators()</code></li>
|
|
58
|
+
<li><code>getSupportedCurrencies()</code></li>
|
|
116
59
|
</ul>
|
|
117
60
|
<p>The <a href="https://procore.github.io/globalization-toolkit/interfaces/CurrencyOptions.html">CurrencyOptions</a> are summarized below:</p>
|
|
118
61
|
<ul>
|
|
@@ -125,28 +68,27 @@ Further reading on the GTK:</p>
|
|
|
125
68
|
</ul>
|
|
126
69
|
<p>Below code blocks display usage of the CurrencyFormatter class and available functions. </p>
|
|
127
70
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html#formatCurrency">formatCurrency(value: number)</a></p>
|
|
128
|
-
<pre><code class="language-ts"><span class="hl-
|
|
129
|
-
</code></pre>
|
|
71
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-US"</span><span class="hl-1">, </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"USD"</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatCurrency</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)) </span><span class="hl-8">// expected outcome: '$1,234.00'</span>
|
|
72
|
+
</code><button>Copy</button></pre>
|
|
130
73
|
<p>Usage with currencyDisplay option</p>
|
|
131
|
-
<pre><code class="language-ts"><span class="hl-
|
|
132
|
-
</code></pre>
|
|
74
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">CurrencyFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234.567</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1">: </span><span class="hl-9">CurrencyOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"de-DE"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"USD"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencyDisplay:</span><span class="hl-1"> </span><span class="hl-2">"name"</span><span class="hl-1">,</span><br/><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatCurrency</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)); </span><span class="hl-8">// expected outcome: '1.234,57 US-Dollar'</span>
|
|
75
|
+
</code><button>Copy</button></pre>
|
|
133
76
|
<p>Usage with minimumFractionDigits and currencyDisplay</p>
|
|
134
|
-
<pre><code class="language-ts"><span class="hl-
|
|
135
|
-
</code></pre>
|
|
77
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234.567</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"ja-JP"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">minimumFractionDigits:</span><span class="hl-1"> </span><span class="hl-7">2</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"JPY"</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatCurrency</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)); </span><span class="hl-8">// expected outcome: '￥1,234.57'</span>
|
|
78
|
+
</code><button>Copy</button></pre>
|
|
136
79
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html#formatCurrencyToParts">formatCurrencyToParts()</a></p>
|
|
137
|
-
<pre><code class="language-ts"><span class="hl-
|
|
138
|
-
</code></pre>
|
|
80
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">CurrencyFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = -</span><span class="hl-7">1234.56</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1">: </span><span class="hl-9">CurrencyOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-US"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"CAD"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencySign:</span><span class="hl-1"> </span><span class="hl-2">"accounting"</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatCurrencyToParts</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">));</span><br/><span class="hl-1"> </span><span class="hl-8">/** expected output:</span><br/><span class="hl-8"> * [</span><br/><span class="hl-8"> * { type: "literal", value: "(", },</span><br/><span class="hl-8"> * { type: "currency", value: "CA$", },</span><br/><span class="hl-8"> * { type: "integer", value: "1", },</span><br/><span class="hl-8"> * { type: "group", value: ",", },</span><br/><span class="hl-8"> * { type: "integer", value: "234", },</span><br/><span class="hl-8"> * { type: "decimal", value: ".", },</span><br/><span class="hl-8"> * { type: "fraction", value: "56", },</span><br/><span class="hl-8"> * { type: "literal", value: ")", },</span><br/><span class="hl-8"> * ]</span><br/><span class="hl-8"> **/</span>
|
|
81
|
+
</code><button>Copy</button></pre>
|
|
139
82
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html#parseCurrency">parseCurrency(value: string)</a></p>
|
|
140
|
-
<pre><code class="language-ts"><span class="hl-
|
|
141
|
-
</code></pre>
|
|
83
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-2">"(1 234 567,56 €)"</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1">: </span><span class="hl-9">CurrencyOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"fr-FR"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"EUR"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">currencySign:</span><span class="hl-1"> </span><span class="hl-2">"accounting"</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">parseCurrency</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">)); </span><span class="hl-8">// expected outcome: -1234567.56</span>
|
|
84
|
+
</code><button>Copy</button></pre>
|
|
142
85
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html#getCurrencySeparators">getCurrencySeparators</a></p>
|
|
143
|
-
<pre><code class="language-ts"><span class="hl-
|
|
144
|
-
</code></pre>
|
|
145
|
-
|
|
146
|
-
<
|
|
147
|
-
|
|
148
|
-
</a>
|
|
149
|
-
<p>The functions used on the CurrencyFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
86
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"de-DE"</span><span class="hl-1">, </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">"EUR"</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">getCurrencySeparators</span><span class="hl-1">()) </span><span class="hl-8">// expected outcome: { decimal: ",", group: "." }</span>
|
|
87
|
+
</code><button>Copy</button></pre>
|
|
88
|
+
<p><a href="https://procore.github.io/globalization-toolkit/classes/CurrencyFormatter.html#getSupportedCurrencies">getSupportedCurrencies</a></p>
|
|
89
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"es-MX"</span><span class="hl-1">, </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-6">MXN</span><span class="hl-2">" </span><span class="hl-10">}</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-5">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">CurrencyFormatter</span><span class="hl-1">(</span><span class="hl-5">currencyOption</span><span class="hl-1">)</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">getSupportedCurrencies</span><span class="hl-1">())</span><br/><span class="hl-1"> </span><span class="hl-8">/** expected outcome</span><br/><span class="hl-8"> * [</span><br/><span class="hl-8"> * "AED",</span><br/><span class="hl-8"> * "AFN",</span><br/><span class="hl-8"> * "ALL",</span><br/><span class="hl-8"> * ...</span><br/><span class="hl-8"> * ...</span><br/><span class="hl-8"> * "ZWL" </span><br/><span class="hl-8"> * ]</span><br/><span class="hl-8"> */</span>
|
|
90
|
+
</code><button>Copy</button></pre>
|
|
91
|
+
<a id="md:currencyformatter-functions" class="tsd-anchor"></a><h3><a href="#md:currencyformatter-functions">CurrencyFormatter Functions</a></h3><p>The functions used on the CurrencyFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
150
92
|
<ul>
|
|
151
93
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatCurrency.html">formatCurrency</a></li>
|
|
152
94
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatCurrencyToParts.html">formatCurrencyToParts</a></li>
|
|
@@ -154,13 +96,9 @@ Further reading on the GTK:</p>
|
|
|
154
96
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/getCurrencySeparators.html">getCurrencySeparators</a></li>
|
|
155
97
|
</ul>
|
|
156
98
|
<p>The example below shows usage of the stand alone function: <code>formatCurrency(value, options)</code>.</p>
|
|
157
|
-
<pre><code class="language-ts"><span class="hl-
|
|
158
|
-
</code></pre>
|
|
159
|
-
|
|
160
|
-
<a href="#datetimeformatter" id="datetimeformatter" style="color: inherit; text-decoration: none;">
|
|
161
|
-
<h3>DateTimeFormatter</h3>
|
|
162
|
-
</a>
|
|
163
|
-
<p>The GTK DateTimeFormatter class has the ability to format date and time for the correct timezone. The <a href="https://procore.github.io/globalization-toolkit/classes/DateTimeFormatter.html">DateTimeFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/types/DateTimeOptions.html">DateTimeOptions</a>.<br>The DateTimeFormatter has 3 available functions: </p>
|
|
99
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">formatCurrency</span><span class="hl-1">, </span><span class="hl-5">getCurrencySeparators</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-7">1234</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">currencyOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">'en-US'</span><span class="hl-1">, </span><span class="hl-5">currencyIsoCode:</span><span class="hl-1"> </span><span class="hl-2">'USD'</span><span class="hl-1"> };</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-0">formatCurrency</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">, </span><span class="hl-5">currencyOptions</span><span class="hl-1">)) </span><span class="hl-8">// expected output: '$1,234.00'</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-0">getCurrencySeparators</span><span class="hl-1">(</span><span class="hl-5">currencyOptions</span><span class="hl-1">)) </span><span class="hl-8">// expected output: { decimal: ".", group: "," }</span>
|
|
100
|
+
</code><button>Copy</button></pre>
|
|
101
|
+
<a id="md:datetimeformatter" class="tsd-anchor"></a><h3><a href="#md:datetimeformatter">DateTimeFormatter</a></h3><p>The GTK DateTimeFormatter class has the ability to format date and time for the correct timezone. The <a href="https://procore.github.io/globalization-toolkit/classes/DateTimeFormatter.html">DateTimeFormatter</a> class is instantiated with <a href="https://procore.github.io/globalization-toolkit/types/DateTimeOptions.html">DateTimeOptions</a>.<br>The DateTimeFormatter has 3 available functions: </p>
|
|
164
102
|
<ul>
|
|
165
103
|
<li><code>formatDateTime(value: Date)</code>, </li>
|
|
166
104
|
<li><code>formatDateTimeToParts(value: Date)</code>, and</li>
|
|
@@ -185,60 +123,45 @@ Further reading on the GTK:</p>
|
|
|
185
123
|
</li>
|
|
186
124
|
</ol>
|
|
187
125
|
<p>Below code blocks display usage of the DateTimeFormatter class and available functions.<br><a href="https://procore.github.io/globalization-toolkit/classes/DateTimeFormatter.html#formatDateTime">formatDateTime(value: Date)</a><br>SIMPLE OPTIONS</p>
|
|
188
|
-
<pre><code class="language-ts"><span class="hl-
|
|
189
|
-
</code></pre>
|
|
126
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">DateTimeFormatter</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">Date</span><span class="hl-1">(</span><span class="hl-7">1445419756738</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">dateTimeOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">'en-US'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">timeZone:</span><span class="hl-1"> </span><span class="hl-2">'UTC'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">dateStyle:</span><span class="hl-1"> </span><span class="hl-2">'full'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">timeStyle:</span><span class="hl-1"> </span><span class="hl-2">'long'</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">DateTimeFormatter</span><span class="hl-1">(</span><span class="hl-5">dateTimeOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatDateTime</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">))</span><br/><span class="hl-8">// expected output: Wednesday, October 21, 2015 at 9:29:16 AM UTC</span>
|
|
127
|
+
</code><button>Copy</button></pre>
|
|
190
128
|
<p>COMPLEX OPTIONS</p>
|
|
191
|
-
<pre><code class="language-js"><span class="hl-
|
|
192
|
-
</code></pre>
|
|
129
|
+
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">Date</span><span class="hl-1">(</span><span class="hl-5">Date</span><span class="hl-1">.</span><span class="hl-0">UTC</span><span class="hl-1">(</span><span class="hl-7">1885</span><span class="hl-1">, </span><span class="hl-7">8</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">12</span><span class="hl-1">, </span><span class="hl-7">0</span><span class="hl-1">, </span><span class="hl-7">16</span><span class="hl-1">, </span><span class="hl-7">738</span><span class="hl-1">));</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">dateTimeOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">'en-US'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">timeZone:</span><span class="hl-1"> </span><span class="hl-2">'UTC'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">weekday:</span><span class="hl-1"> </span><span class="hl-2">'long'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">year:</span><span class="hl-1"> </span><span class="hl-2">'numeric'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">month:</span><span class="hl-1"> </span><span class="hl-2">'2-digit'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">day:</span><span class="hl-1"> </span><span class="hl-2">'2-digit'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">hour:</span><span class="hl-1"> </span><span class="hl-2">'numeric'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">minute:</span><span class="hl-1"> </span><span class="hl-2">'2-digit'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">second:</span><span class="hl-1"> </span><span class="hl-2">'2-digit'</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">DateTimeFormatter</span><span class="hl-1">(</span><span class="hl-5">dateTimeOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatDateTime</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">))</span><br/><span class="hl-8">// expected output: "Tuesday, 09/01/1885, 12:00:16 PM";</span>
|
|
130
|
+
</code><button>Copy</button></pre>
|
|
193
131
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/DateTimeFormatter.html#formatDateTimeToParts">formatDateTimeToParts(value: Date)</a></p>
|
|
194
|
-
<pre><code class="language-ts"><span class="hl-
|
|
195
|
-
</code></pre>
|
|
132
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">Date</span><span class="hl-1">(</span><span class="hl-5">Date</span><span class="hl-1">.</span><span class="hl-0">UTC</span><span class="hl-1">(</span><span class="hl-7">1955</span><span class="hl-1">, </span><span class="hl-7">10</span><span class="hl-1">, </span><span class="hl-7">5</span><span class="hl-1">, </span><span class="hl-7">6</span><span class="hl-1">, </span><span class="hl-7">0</span><span class="hl-1">, </span><span class="hl-7">16</span><span class="hl-1">, </span><span class="hl-7">738</span><span class="hl-1">));</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">dateTimeOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-GB"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">timeZone:</span><span class="hl-1"> </span><span class="hl-2">"UTC"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">dateStyle:</span><span class="hl-1"> </span><span class="hl-5">DateStyle</span><span class="hl-1">.</span><span class="hl-6">FULL</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">timeStyle:</span><span class="hl-1"> </span><span class="hl-5">TimeStyle</span><span class="hl-1">.</span><span class="hl-6">SHORT</span><span class="hl-1">,</span><br/><span class="hl-1">};</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">DateTimeFormatter</span><span class="hl-1">(</span><span class="hl-5">dateTimeOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">formatDateTime</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">))</span><br/><span class="hl-1"> </span><span class="hl-8">/** expected output: </span><br/><span class="hl-8"> * [ { type: "weekday", value: "Saturday", },</span><br/><span class="hl-8"> * { type: "literal", value: ", ", },</span><br/><span class="hl-8"> * { type: "day", value: "5", },</span><br/><span class="hl-8"> * { type: "literal", value: " ", },</span><br/><span class="hl-8"> * { type: "month", value: "November", },</span><br/><span class="hl-8"> * { type: "literal", value: " ", },</span><br/><span class="hl-8"> * { type: "year", value: "1955", },</span><br/><span class="hl-8"> * { type: "literal", value: " at ",},</span><br/><span class="hl-8"> * { type: "hour", value: "06",},</span><br/><span class="hl-8"> * { type: "literal", value: ":",},</span><br/><span class="hl-8"> * { type: "minute", value: "00",}, ];</span><br/><span class="hl-8"> **/</span>
|
|
133
|
+
</code><button>Copy</button></pre>
|
|
196
134
|
<p><a href="https://procore.github.io/globalization-toolkit/classes/DateTimeFormatter.html#getStartDayOfTheWeek">getStartDayOfTheWeek()</a><br>This function returns an index value representing the start day of the week on the locale's calendar { Sunday: 0, Monday: 1 ...etc }</p>
|
|
197
|
-
<pre><code class="language-ts"><span class="hl-
|
|
198
|
-
</code></pre>
|
|
199
|
-
|
|
200
|
-
<a href="#datetimeformatter-functions" id="datetimeformatter-functions" style="color: inherit; text-decoration: none;">
|
|
201
|
-
<h3>DateTimeFormatter Functions</h3>
|
|
202
|
-
</a>
|
|
203
|
-
<p>The functions used on the NumberFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
135
|
+
<pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">dateTimeOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">'en-US'</span><span class="hl-1"> };</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">formatter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">DateTimeFormatter</span><span class="hl-1">(</span><span class="hl-5">dateTimeOptions</span><span class="hl-1">);</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-5">formatter</span><span class="hl-1">.</span><span class="hl-0">startDayOfTheWeek</span><span class="hl-1">()); </span><span class="hl-8">// expected output: 0</span>
|
|
136
|
+
</code><button>Copy</button></pre>
|
|
137
|
+
<a id="md:datetimeformatter-functions" class="tsd-anchor"></a><h3><a href="#md:datetimeformatter-functions">DateTimeFormatter Functions</a></h3><p>The functions used on the NumberFormatter class are also available as stand alone functions. Read more information about each function in the GTK Documentation.</p>
|
|
204
138
|
<ul>
|
|
205
139
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatDateTime.html">formatDateTime()</a></li>
|
|
206
140
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/formatDateTimeToParts.html">formaDateTimeToParts()</a></li>
|
|
207
141
|
<li><a href="https://procore.github.io/globalization-toolkit/functions/getStartDayOfTheWeek.html">getStartDayOfTheWeek(locale: string)</a></li>
|
|
208
142
|
</ul>
|
|
209
143
|
<p>The example below shows usage of the stand alone function: <code>formatDateTime()</code>.</p>
|
|
210
|
-
<pre><code class="language-ts"><span class="hl-
|
|
211
|
-
</code></pre>
|
|
144
|
+
<pre><code class="language-ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">formatDateTime</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">'@procore/globalization-toolkit'</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">value</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">Date</span><span class="hl-1">(</span><span class="hl-5">Date</span><span class="hl-1">.</span><span class="hl-0">UTC</span><span class="hl-1">(</span><span class="hl-7">1955</span><span class="hl-1">, </span><span class="hl-7">10</span><span class="hl-1">, </span><span class="hl-7">5</span><span class="hl-1">, </span><span class="hl-7">6</span><span class="hl-1">, </span><span class="hl-7">0</span><span class="hl-1">, </span><span class="hl-7">16</span><span class="hl-1">, </span><span class="hl-7">738</span><span class="hl-1">));</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">dateTimeOptions</span><span class="hl-1"> = { </span><span class="hl-5">locale:</span><span class="hl-1"> </span><span class="hl-2">"en-US"</span><span class="hl-1">, </span><span class="hl-5">timeZone:</span><span class="hl-1"> </span><span class="hl-2">"UTC"</span><span class="hl-1"> };</span><br/><br/><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-0">formatDateTime</span><span class="hl-1">(</span><span class="hl-5">value</span><span class="hl-1">, </span><span class="hl-5">dateTimeOptions</span><span class="hl-1">)) </span><span class="hl-8">// expected output: 11/5/1955</span>
|
|
145
|
+
</code><button>Copy</button></pre>
|
|
146
|
+
<a id="md:polyfills" class="tsd-anchor"></a><h2><a href="#md:polyfills">Polyfills</a></h2><p>The GTK implementation relies heavily on <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl">Intl</a> functionality. This is generally well-supported by browsers, but depending on the browser versions you intend to support and GTK features you plan to use, it may require polyfills. In particular, consumers have seen issues with Safari versions <14.1. If you intend to support older browser versions, we recommend using the <a href="https://formatjs.io/docs/polyfills">Format.JS polyfills</a>, of which <code>NumberFormat</code>, <code>PluralRules</code>, <code>Locale</code>, <code>GetCanonicalLocales</code>, and <code>supportedValuesOf</code> are the ones relevant to GTK. Please reach out if you have questions.</p>
|
|
212
147
|
<hr>
|
|
213
|
-
|
|
214
|
-
<
|
|
215
|
-
|
|
216
|
-
</a>
|
|
217
|
-
<p>Install dependencies:</p>
|
|
218
|
-
<pre><code class="language-sh"><span class="hl-0">$ </span><span class="hl-1">npm</span><span class="hl-0"> </span><span class="hl-1">install</span>
|
|
219
|
-
</code></pre>
|
|
148
|
+
<a id="md:developing" class="tsd-anchor"></a><h1><a href="#md:developing">Developing</a></h1><p>Install dependencies:</p>
|
|
149
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">install</span>
|
|
150
|
+
</code><button>Copy</button></pre>
|
|
220
151
|
<p>Prepare project:</p>
|
|
221
|
-
<pre><code class="language-sh"><span class="hl-0"
|
|
222
|
-
</code></pre>
|
|
152
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">prepare</span>
|
|
153
|
+
</code><button>Copy</button></pre>
|
|
223
154
|
<p>Compile Typescript:</p>
|
|
224
|
-
<pre><code class="language-sh"><span class="hl-0"
|
|
225
|
-
</code></pre>
|
|
155
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">build</span>
|
|
156
|
+
</code><button>Copy</button></pre>
|
|
226
157
|
<p>(Delete build <code>npm run clean</code>)</p>
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
<h2>Testing</h2>
|
|
230
|
-
</a>
|
|
231
|
-
<pre><code class="language-sh"><span class="hl-0">$ </span><span class="hl-1">npm</span><span class="hl-0"> </span><span class="hl-1">run</span><span class="hl-0"> </span><span class="hl-1">test</span>
|
|
232
|
-
</code></pre>
|
|
158
|
+
<a id="md:testing" class="tsd-anchor"></a><h2><a href="#md:testing">Testing</a></h2><pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test</span>
|
|
159
|
+
</code><button>Copy</button></pre>
|
|
233
160
|
<p>If adding a new supported export (or removing one in a breaking change), update the snapshot test output and commit the change.</p>
|
|
234
|
-
<pre><code class="language-sh"><span class="hl-0"
|
|
235
|
-
</code></pre>
|
|
161
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">test</span><span class="hl-1"> </span><span class="hl-3">--</span><span class="hl-1"> </span><span class="hl-3">-u</span>
|
|
162
|
+
</code><button>Copy</button></pre>
|
|
236
163
|
<p>To check formatting run <code>npm run lint:check</code> and <code>npm run format:check</code>.</p>
|
|
237
|
-
|
|
238
|
-
<a href="#committing-changes" id="committing-changes" style="color: inherit; text-decoration: none;">
|
|
239
|
-
<h2>Committing Changes</h2>
|
|
240
|
-
</a>
|
|
241
|
-
<p>Our repo follows the <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a>
|
|
164
|
+
<a id="md:committing-changes" class="tsd-anchor"></a><h2><a href="#md:committing-changes">Committing Changes</a></h2><p>Our repo follows the <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a>
|
|
242
165
|
and <a href="https://semver.org/">Semantic Versioning</a> specifications.
|
|
243
166
|
The Conventional Commit format is used to map commits to the next Semantic Version published to <code>NPM</code>,
|
|
244
167
|
and helps to maintain a more easily readable commit history.</p>
|
|
@@ -248,17 +171,13 @@ and helps to maintain a more easily readable commit history.</p>
|
|
|
248
171
|
[optional body]
|
|
249
172
|
|
|
250
173
|
[optional footer(s)]
|
|
251
|
-
</code></pre>
|
|
174
|
+
</code><button>Copy</button></pre>
|
|
252
175
|
<p>We use the command line tool <a href="https://github.com/commitizen/cz-cli#using-the-command-line-tool"><code>commitizen</code></a> to help walk you through generating a Conventional Commit.</p>
|
|
253
176
|
<p><strong>To invoke this tool run:</strong></p>
|
|
254
|
-
<pre><code class="language-sh"><span class="hl-0"
|
|
255
|
-
</code></pre>
|
|
177
|
+
<pre><code class="language-sh"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">cm</span>
|
|
178
|
+
</code><button>Copy</button></pre>
|
|
256
179
|
<p>(Optional: <a href="https://github.com/commitizen/cz-cli#optional-running-commitizen-on-git-commit">run commitizen on <code>git commit</code></a>)</p>
|
|
257
|
-
|
|
258
|
-
<a href="#certain-commits-are-analyzed-and-mapped-to-versioning-as-follows" id="certain-commits-are-analyzed-and-mapped-to-versioning-as-follows" style="color: inherit; text-decoration: none;">
|
|
259
|
-
<h4>Certain commits are analyzed and mapped to versioning as follows:</h4>
|
|
260
|
-
</a>
|
|
261
|
-
<ul>
|
|
180
|
+
<a id="md:certain-commits-are-analyzed-and-mapped-to-versioning-as-follows" class="tsd-anchor"></a><h4><a href="#md:certain-commits-are-analyzed-and-mapped-to-versioning-as-follows">Certain commits are analyzed and mapped to versioning as follows:</a></h4><ul>
|
|
262
181
|
<li><p><code>MAJOR</code> release if <code>BREAKING CHANGE</code> exists in the commit footer.</p>
|
|
263
182
|
</li>
|
|
264
183
|
<li><p><code>MINOR</code> release for commit type <code>feat</code>.</p>
|
|
@@ -276,124 +195,18 @@ will not trigger a release.</p>
|
|
|
276
195
|
<li><code>build(deps):</code> triggers a <code>PATCH</code> release.</li>
|
|
277
196
|
</ul>
|
|
278
197
|
<p><em>Details about how commit types are mapped to versioning can be found in the <a href="https://github.com/semantic-release/commit-analyzer/#default-rules-matching">commit-analyzer documentation</a>.</em></p>
|
|
279
|
-
|
|
280
|
-
<a href="#publishing" id="publishing" style="color: inherit; text-decoration: none;">
|
|
281
|
-
<h1>Publishing</h1>
|
|
282
|
-
</a>
|
|
283
|
-
<p>Merges to <code>main</code> will trigger the <code>publish</code> workflow in CircleCi.
|
|
198
|
+
<a id="md:publishing" class="tsd-anchor"></a><h1><a href="#md:publishing">Publishing</a></h1><p>Merges to <code>main</code> will trigger the <code>publish</code> workflow in CircleCi.
|
|
284
199
|
We use <a href="https://semantic-release.gitbook.io/semantic-release/"><code>semantic-release</code></a> to manage releases and publishing to <code>NPM</code>.
|
|
285
200
|
Semantic Release relies on the project's commit history
|
|
286
201
|
to create release notes and determine the next version.</p>
|
|
287
|
-
|
|
288
|
-
<a href="#release-notes" id="release-notes" style="color: inherit; text-decoration: none;">
|
|
289
|
-
<h3>Release Notes:</h3>
|
|
290
|
-
</a>
|
|
291
|
-
<p>The <code><description></code> for commits selected for publishing are added to the release notes
|
|
202
|
+
<a id="md:release-notes" class="tsd-anchor"></a><h3><a href="#md:release-notes">Release Notes:</a></h3><p>The <code><description></code> for commits selected for publishing are added to the release notes
|
|
292
203
|
and can be found in the <strong>Releases</strong> section of Github.</p>
|
|
293
|
-
|
|
294
|
-
<a
|
|
295
|
-
<h2>License</h2>
|
|
296
|
-
</a>
|
|
297
|
-
<p>The package is available under the <a href="https://www.procore.com/legal/api-terms-and-conditions">Procore Developers License</a></p>
|
|
298
|
-
|
|
299
|
-
<a href="#about-procore" id="about-procore" style="color: inherit; text-decoration: none;">
|
|
300
|
-
<h2>About Procore</h2>
|
|
301
|
-
</a>
|
|
302
|
-
<p><img
|
|
204
|
+
<a id="md:license" class="tsd-anchor"></a><h2><a href="#md:license">License</a></h2><p>The package is available under the <a href="https://www.procore.com/legal/api-terms-and-conditions">Procore Developers License</a></p>
|
|
205
|
+
<a id="md:about-procore" class="tsd-anchor"></a><h2><a href="#md:about-procore">About Procore</a></h2><p><img
|
|
303
206
|
src="https://www.procore.com/images/procore_logo.png"
|
|
304
207
|
alt="Procore Logo"
|
|
305
208
|
width="250px"
|
|
306
209
|
/></p>
|
|
307
210
|
<p>Procore - building the software that builds the world.</p>
|
|
308
211
|
<p>Learn more about the #1 most widely used construction management software at <a href="https://www.procore.com/">procore.com</a></p>
|
|
309
|
-
</div></div>
|
|
310
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
311
|
-
<div class="tsd-navigation settings">
|
|
312
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
313
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
314
|
-
<div class="tsd-accordion-details">
|
|
315
|
-
<div class="tsd-filter-visibility">
|
|
316
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
317
|
-
<ul id="tsd-filter-options">
|
|
318
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
319
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
320
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
321
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
322
|
-
<div class="tsd-theme-toggle">
|
|
323
|
-
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
324
|
-
<nav class="tsd-navigation primary">
|
|
325
|
-
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
326
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
327
|
-
<div class="tsd-accordion-details">
|
|
328
|
-
<ul>
|
|
329
|
-
<li class="current selected"><a href="modules.html">@procore/globalization-<wbr/>toolkit</a>
|
|
330
|
-
<ul></ul></li></ul></div></details></nav>
|
|
331
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
332
|
-
<ul>
|
|
333
|
-
<li class="tsd-kind-class"><a href="classes/CurrencyFormatter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Currency<wbr/>Formatter</a></li>
|
|
334
|
-
<li class="tsd-kind-class"><a href="classes/DateTimeFormatter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Date<wbr/>Time<wbr/>Formatter</a></li>
|
|
335
|
-
<li class="tsd-kind-class"><a href="classes/NumberFormatter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Number<wbr/>Formatter</a></li>
|
|
336
|
-
<li class="tsd-kind-interface"><a href="interfaces/CurrencyOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Currency<wbr/>Options</a></li>
|
|
337
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsBasic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Basic</a></li>
|
|
338
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsAll.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>All</a></li>
|
|
339
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsHourMinute.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Hour<wbr/>Minute</a></li>
|
|
340
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsHourMinuteSecond.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Hour<wbr/>Minute<wbr/>Second</a></li>
|
|
341
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsMonthDay.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Month<wbr/>Day</a></li>
|
|
342
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsWeekdayYearMonthDay.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Weekday<wbr/>Year<wbr/>Month<wbr/>Day</a></li>
|
|
343
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsYearMonth.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Year<wbr/>Month</a></li>
|
|
344
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsComponentsYearMonthDay.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Components<wbr/>Year<wbr/>Month<wbr/>Day</a></li>
|
|
345
|
-
<li class="tsd-kind-interface"><a href="interfaces/DateTimeOptionsStyle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Date<wbr/>Time<wbr/>Options<wbr/>Style</a></li>
|
|
346
|
-
<li class="tsd-kind-interface"><a href="interfaces/NumberOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Number<wbr/>Options</a></li>
|
|
347
|
-
<li class="tsd-kind-type-alias"><a href="types/CurrencyDisplay.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Currency<wbr/>Display</a></li>
|
|
348
|
-
<li class="tsd-kind-type-alias"><a href="types/CurrencySign.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Currency<wbr/>Sign</a></li>
|
|
349
|
-
<li class="tsd-kind-type-alias"><a href="types/DateLabelOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Date<wbr/>Label<wbr/>Options</a></li>
|
|
350
|
-
<li class="tsd-kind-type-alias"><a href="types/DateStyle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Date<wbr/>Style</a></li>
|
|
351
|
-
<li class="tsd-kind-type-alias"><a href="types/DateTimeFormatPart.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Date<wbr/>Time<wbr/>Format<wbr/>Part</a></li>
|
|
352
|
-
<li class="tsd-kind-type-alias"><a href="types/DateTimeOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Date<wbr/>Time<wbr/>Options</a></li>
|
|
353
|
-
<li class="tsd-kind-type-alias"><a href="types/DateTimeStyle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Date<wbr/>Time<wbr/>Style</a></li>
|
|
354
|
-
<li class="tsd-kind-type-alias"><a href="types/Day.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Day</a></li>
|
|
355
|
-
<li class="tsd-kind-type-alias"><a href="types/FormatterOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Formatter<wbr/>Options</a></li>
|
|
356
|
-
<li class="tsd-kind-type-alias"><a href="types/Hour.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Hour</a></li>
|
|
357
|
-
<li class="tsd-kind-type-alias"><a href="types/Locale.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Locale</a></li>
|
|
358
|
-
<li class="tsd-kind-type-alias"><a href="types/Minute.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Minute</a></li>
|
|
359
|
-
<li class="tsd-kind-type-alias"><a href="types/Month.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Month</a></li>
|
|
360
|
-
<li class="tsd-kind-type-alias"><a href="types/NumberFormatPart.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Number<wbr/>Format<wbr/>Part</a></li>
|
|
361
|
-
<li class="tsd-kind-type-alias"><a href="types/NumericTwoDigit.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Numeric<wbr/>Two<wbr/>Digit</a></li>
|
|
362
|
-
<li class="tsd-kind-type-alias"><a href="types/Percent.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Percent</a></li>
|
|
363
|
-
<li class="tsd-kind-type-alias"><a href="types/Second.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Second</a></li>
|
|
364
|
-
<li class="tsd-kind-type-alias"><a href="types/Separators.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Separators</a></li>
|
|
365
|
-
<li class="tsd-kind-type-alias"><a href="types/TimeStyle.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Time<wbr/>Style</a></li>
|
|
366
|
-
<li class="tsd-kind-type-alias"><a href="types/TimeZoneName.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Time<wbr/>Zone<wbr/>Name</a></li>
|
|
367
|
-
<li class="tsd-kind-type-alias"><a href="types/Weekday.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Weekday</a></li>
|
|
368
|
-
<li class="tsd-kind-type-alias"><a href="types/Year.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Year</a></li>
|
|
369
|
-
<li class="tsd-kind-variable"><a href="variables/CurrencyDisplay-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>Currency<wbr/>Display</a></li>
|
|
370
|
-
<li class="tsd-kind-variable"><a href="variables/CurrencySign-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Currency<wbr/>Sign</a></li>
|
|
371
|
-
<li class="tsd-kind-variable"><a href="variables/DateStyle-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Date<wbr/>Style</a></li>
|
|
372
|
-
<li class="tsd-kind-variable"><a href="variables/DateTimeStyle-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Date<wbr/>Time<wbr/>Style</a></li>
|
|
373
|
-
<li class="tsd-kind-variable"><a href="variables/Day-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Day</a></li>
|
|
374
|
-
<li class="tsd-kind-variable"><a href="variables/Hour-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Hour</a></li>
|
|
375
|
-
<li class="tsd-kind-variable"><a href="variables/Minute-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Minute</a></li>
|
|
376
|
-
<li class="tsd-kind-variable"><a href="variables/Month-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Month</a></li>
|
|
377
|
-
<li class="tsd-kind-variable"><a href="variables/NumericTwoDigit-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Numeric<wbr/>Two<wbr/>Digit</a></li>
|
|
378
|
-
<li class="tsd-kind-variable"><a href="variables/Percent-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Percent</a></li>
|
|
379
|
-
<li class="tsd-kind-variable"><a href="variables/Second-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Second</a></li>
|
|
380
|
-
<li class="tsd-kind-variable"><a href="variables/TimeStyle-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Time<wbr/>Style</a></li>
|
|
381
|
-
<li class="tsd-kind-variable"><a href="variables/TimeZoneName-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Time<wbr/>Zone<wbr/>Name</a></li>
|
|
382
|
-
<li class="tsd-kind-variable"><a href="variables/Weekday-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Weekday</a></li>
|
|
383
|
-
<li class="tsd-kind-variable"><a href="variables/Year-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>Year</a></li>
|
|
384
|
-
<li class="tsd-kind-function"><a href="functions/formatCurrency.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>format<wbr/>Currency</a></li>
|
|
385
|
-
<li class="tsd-kind-function"><a href="functions/formatCurrencyToParts.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Currency<wbr/>To<wbr/>Parts</a></li>
|
|
386
|
-
<li class="tsd-kind-function"><a href="functions/formatDateTime.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Date<wbr/>Time</a></li>
|
|
387
|
-
<li class="tsd-kind-function"><a href="functions/formatDateTimeToParts.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Date<wbr/>Time<wbr/>To<wbr/>Parts</a></li>
|
|
388
|
-
<li class="tsd-kind-function"><a href="functions/formatNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Number</a></li>
|
|
389
|
-
<li class="tsd-kind-function"><a href="functions/formatNumberToParts.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>format<wbr/>Number<wbr/>To<wbr/>Parts</a></li>
|
|
390
|
-
<li class="tsd-kind-function"><a href="functions/getCurrencySeparators.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Currency<wbr/>Separators</a></li>
|
|
391
|
-
<li class="tsd-kind-function"><a href="functions/getDatePartsWithPlaceholders.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Date<wbr/>Parts<wbr/>With<wbr/>Placeholders</a></li>
|
|
392
|
-
<li class="tsd-kind-function"><a href="functions/getDatePlaceholder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Date<wbr/>Placeholder</a></li>
|
|
393
|
-
<li class="tsd-kind-function"><a href="functions/getNumberSeparators.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Number<wbr/>Separators</a></li>
|
|
394
|
-
<li class="tsd-kind-function"><a href="functions/getStartDayOfTheWeek.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>get<wbr/>Start<wbr/>Day<wbr/>Of<wbr/>The<wbr/>Week</a></li>
|
|
395
|
-
<li class="tsd-kind-function"><a href="functions/parseCurrency.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>parse<wbr/>Currency</a></li>
|
|
396
|
-
<li class="tsd-kind-function"><a href="functions/parseNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>parse<wbr/>Number</a></li></ul></nav></div></div>
|
|
397
|
-
<div class="container tsd-generator">
|
|
398
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
399
|
-
<div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
|
212
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><ul><li><a href="#md:globalization-toolkit"><span>globalization-<wbr/>toolkit</span></a></li><li><ul><li><a href="#md:engineering-documentation"><span>Engineering <wbr/>Documentation</span></a></li><li><a href="#md:install"><span>Install</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><ul><li><a href="#md:a-note-on-locales"><span>A <wbr/>Note on <wbr/>Locales</span></a></li><li><a href="#md:numberformatter-class"><span>Number<wbr/>Formatter <wbr/>Class</span></a></li><li><ul><li><a href="#md:formatnumber-amp-formatnumbertoparts"><span>format<wbr/>Number() & format<wbr/>Number<wbr/>To<wbr/>Parts()</span></a></li><li><a href="#md:parsenumber"><span>parse<wbr/>Number()</span></a></li><li><a href="#md:getseparators"><span>get<wbr/>Separators()</span></a></li></ul></li><li><a href="#md:numberformatter-functions"><span>Number<wbr/>Formatter <wbr/>Functions</span></a></li><li><a href="#md:currencyformatter-class"><span>Currency<wbr/>Formatter class</span></a></li><li><a href="#md:currencyformatter-functions"><span>Currency<wbr/>Formatter <wbr/>Functions</span></a></li><li><a href="#md:datetimeformatter"><span>Date<wbr/>Time<wbr/>Formatter</span></a></li><li><a href="#md:datetimeformatter-functions"><span>Date<wbr/>Time<wbr/>Formatter <wbr/>Functions</span></a></li></ul></li><li><a href="#md:polyfills"><span>Polyfills</span></a></li></ul></li><li><a href="#md:developing"><span>Developing</span></a></li><li><ul><li><a href="#md:testing"><span>Testing</span></a></li><li><a href="#md:committing-changes"><span>Committing <wbr/>Changes</span></a></li><li><ul><li><a href="#md:certain-commits-are-analyzed-and-mapped-to-versioning-as-follows"><span>Certain commits are analyzed and mapped to versioning as follows:</span></a></li></ul></li></ul></li><li><a href="#md:publishing"><span>Publishing</span></a></li><li><ul><li><a href="#md:release-notes"><span>Release <wbr/>Notes:</span></a></li><li><a href="#md:license"><span>License</span></a></li><li><a href="#md:about-procore"><span>About <wbr/>Procore</span></a></li></ul></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@procore/globalization-toolkit</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li><a href="classes/CurrencyFormatter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CurrencyFormatter</a></li><li><a href="classes/DateTimeFormatter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DateTimeFormatter</a></li><li><a href="classes/NumberFormatter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>NumberFormatter</a></li><li><a href="interfaces/CurrencyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>CurrencyOptions</a></li><li><a href="interfaces/DateTimeOptionsBasic.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsBasic</a></li><li><a href="interfaces/DateTimeOptionsComponentsAll.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsAll</a></li><li><a href="interfaces/DateTimeOptionsComponentsHourMinute.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsHourMinute</a></li><li><a href="interfaces/DateTimeOptionsComponentsHourMinuteSecond.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsHourMinuteSecond</a></li><li><a href="interfaces/DateTimeOptionsComponentsMonthDay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsMonthDay</a></li><li><a href="interfaces/DateTimeOptionsComponentsWeekdayYearMonthDay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsWeekdayYearMonthDay</a></li><li><a href="interfaces/DateTimeOptionsComponentsYearMonth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsYearMonth</a></li><li><a href="interfaces/DateTimeOptionsComponentsYearMonthDay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsComponentsYearMonthDay</a></li><li><a href="interfaces/DateTimeOptionsStyle.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>DateTimeOptionsStyle</a></li><li><a href="interfaces/NumberOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>NumberOptions</a></li><li><a href="types/CurrencyDisplay.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>CurrencyDisplay</a></li><li><a href="types/CurrencySign.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>CurrencySign</a></li><li><a href="types/DateLabelOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DateLabelOptions</a></li><li><a href="types/DateStyle.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DateStyle</a></li><li><a href="types/DateTimeFormatPart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DateTimeFormatPart</a></li><li><a href="types/DateTimeOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DateTimeOptions</a></li><li><a href="types/DateTimeStyle.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg>DateTimeStyle</a></li><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g 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></g></g></svg></body></html>
|