@procore/globalization-toolkit 1.15.3 → 1.16.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/.eslintrc.js +1 -0
- package/dist/dateTimes/DateTime.types.d.ts +12 -0
- package/dist/dateTimes/DateTime.types.js +5 -1
- package/dist/dateTimes/DateTime.types.js.map +1 -1
- package/dist/dateTimes/DateTimeFormatter.d.ts +3 -1
- package/dist/dateTimes/DateTimeFormatter.js +32 -1
- package/dist/dateTimes/DateTimeFormatter.js.map +1 -1
- package/dist/dateTimes/DateTimeUtils.js +2 -0
- package/dist/dateTimes/DateTimeUtils.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/numbers/CurrencyFormatter.js +1 -1
- package/dist/numbers/CurrencyFormatter.js.map +1 -1
- package/dist/numbers/NumberFormatter.d.ts +1 -1
- package/dist/numbers/NumberFormatter.js +1 -1
- package/dist/numbers/NumberFormatter.js.map +1 -1
- package/dist/numbers/NumberFormatter.test.constants.d.ts +2 -0
- package/dist/numbers/NumberFormatter.test.constants.js +6057 -0
- package/dist/numbers/NumberFormatter.test.constants.js.map +1 -0
- package/dist/numbers/NumberUtils.js +2 -2
- package/dist/numbers/NumberUtils.js.map +1 -1
- package/dist/test/TestBuilder.d.ts +26 -0
- package/dist/test/TestBuilder.js +20 -0
- package/dist/test/TestBuilder.js.map +1 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/docs/assets/highlight.css +6 -6
- package/docs/assets/main.js +56 -52
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +23 -0
- package/docs/classes/CurrencyFormatter.html +7 -7
- package/docs/classes/DateTimeFormatter.html +6 -6
- package/docs/classes/NumberFormatter.html +8 -8
- package/docs/functions/formatCurrency.html +6 -1
- package/docs/functions/formatCurrencyToParts.html +6 -1
- package/docs/functions/formatDateTime.html +6 -1
- package/docs/functions/formatDateTimeToParts.html +6 -1
- package/docs/functions/formatNumber.html +6 -1
- package/docs/functions/formatNumberToParts.html +6 -1
- package/docs/functions/getCurrencySeparators.html +6 -1
- package/docs/functions/getDatePartsWithPlaceholders.html +129 -0
- package/docs/functions/getDatePlaceholder.html +129 -0
- package/docs/functions/getNumberSeparators.html +6 -1
- package/docs/functions/getStartDayOfTheWeek.html +6 -1
- package/docs/functions/parseCurrency.html +6 -1
- package/docs/functions/parseNumber.html +6 -1
- package/docs/index.html +30 -25
- package/docs/interfaces/CurrencyOptions.html +7 -7
- package/docs/interfaces/DateTimeOptionsBasic.html +20 -6
- package/docs/interfaces/DateTimeOptionsComponentsAll.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsHourMinute.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsHourMinuteSecond.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsMonthDay.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsWeekdayYearMonthDay.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsYearMonth.html +28 -12
- package/docs/interfaces/DateTimeOptionsComponentsYearMonthDay.html +28 -12
- package/docs/interfaces/DateTimeOptionsStyle.html +28 -12
- package/docs/interfaces/NumberOptions.html +5 -5
- package/docs/modules.html +10 -0
- package/docs/types/CurrencyDisplay.html +7 -2
- package/docs/types/CurrencySign.html +7 -2
- package/docs/types/DateLabelOptions.html +119 -0
- package/docs/types/DateStyle.html +7 -2
- package/docs/types/DateTimeFormatPart.html +6 -1
- package/docs/types/DateTimeOptions.html +6 -1
- package/docs/types/DateTimeStyle.html +7 -2
- package/docs/types/Day.html +7 -2
- package/docs/types/FormatterOptions.html +6 -1
- package/docs/types/Hour.html +7 -2
- package/docs/types/Locale.html +6 -1
- package/docs/types/Minute.html +7 -2
- package/docs/types/Month.html +7 -2
- package/docs/types/NumberFormatPart.html +6 -1
- package/docs/types/NumericTwoDigit.html +7 -2
- package/docs/types/Percent.html +7 -2
- package/docs/types/Second.html +7 -2
- package/docs/types/Separators.html +6 -1
- package/docs/types/TimeStyle.html +7 -2
- package/docs/types/TimeZoneName.html +111 -0
- package/docs/types/Weekday.html +7 -2
- package/docs/types/Year.html +7 -2
- package/docs/variables/CurrencyDisplay-1.html +7 -2
- package/docs/variables/CurrencySign-1.html +7 -2
- package/docs/variables/DateStyle-1.html +7 -2
- package/docs/variables/DateTimeStyle-1.html +7 -2
- package/docs/variables/Day-1.html +7 -2
- package/docs/variables/Hour-1.html +7 -2
- package/docs/variables/Minute-1.html +7 -2
- package/docs/variables/Month-1.html +7 -2
- package/docs/variables/NumericTwoDigit-1.html +7 -2
- package/docs/variables/Percent-1.html +7 -2
- package/docs/variables/Second-1.html +7 -2
- package/docs/variables/TimeStyle-1.html +7 -2
- package/docs/variables/TimeZoneName-1.html +118 -0
- package/docs/variables/Weekday-1.html +7 -2
- package/docs/variables/Year-1.html +7 -2
- package/package.json +5 -5
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li><span class="target">CurrencyFormatter</span></li></ul></section><aside class="tsd-sources">
|
|
22
22
|
<ul>
|
|
23
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
23
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L7">numbers/CurrencyFormatter.ts:7</a></li></ul></aside>
|
|
24
24
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
25
|
<section class="tsd-panel tsd-index-panel">
|
|
26
26
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -57,14 +57,14 @@
|
|
|
57
57
|
</div></li></ul></div>
|
|
58
58
|
<h4 class="tsd-returns-title">Returns <a href="CurrencyFormatter.html" class="tsd-signature-type" data-tsd-kind="Class">CurrencyFormatter</a></h4><aside class="tsd-sources">
|
|
59
59
|
<ul>
|
|
60
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
60
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L13">numbers/CurrencyFormatter.ts:13</a></li></ul></aside></li></ul></section></section>
|
|
61
61
|
<section class="tsd-panel-group tsd-member-group">
|
|
62
62
|
<h2>Properties</h2>
|
|
63
63
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
|
|
64
64
|
<h3 class="tsd-anchor-link"><span>formatter</span><a href="#formatter" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
65
65
|
<div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NumberFormat</span></div><aside class="tsd-sources">
|
|
66
66
|
<ul>
|
|
67
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
67
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L8">numbers/CurrencyFormatter.ts:8</a></li></ul></aside></section></section>
|
|
68
68
|
<section class="tsd-panel-group tsd-member-group">
|
|
69
69
|
<h2>Methods</h2>
|
|
70
70
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatCurrency" class="tsd-anchor"></a>
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
</div></li></ul></div>
|
|
86
86
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
87
87
|
<ul>
|
|
88
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
88
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L22">numbers/CurrencyFormatter.ts:22</a></li></ul></aside></li></ul></section>
|
|
89
89
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatCurrencyToParts" class="tsd-anchor"></a>
|
|
90
90
|
<h3 class="tsd-anchor-link"><span>format<wbr/>Currency<wbr/>To<wbr/>Parts</span><a href="#formatCurrencyToParts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
91
91
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
</div></li></ul></div>
|
|
105
105
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NumberFormatPart</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
106
106
|
<ul>
|
|
107
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
107
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L31">numbers/CurrencyFormatter.ts:31</a></li></ul></aside></li></ul></section>
|
|
108
108
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCurrencySeparators" class="tsd-anchor"></a>
|
|
109
109
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Currency<wbr/>Separators</span><a href="#getCurrencySeparators" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
110
110
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
</div>
|
|
117
117
|
<h4 class="tsd-returns-title">Returns <a href="../types/Separators.html" class="tsd-signature-type" data-tsd-kind="Type alias">Separators</a></h4><aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L87">numbers/CurrencyFormatter.ts:87</a></li></ul></aside></li></ul></section>
|
|
120
120
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="parseCurrency" class="tsd-anchor"></a>
|
|
121
121
|
<h3 class="tsd-anchor-link"><span>parse<wbr/>Currency</span><a href="#parseCurrency" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
122
122
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
</div></li></ul></div>
|
|
136
136
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
137
137
|
<ul>
|
|
138
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
138
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L40">numbers/CurrencyFormatter.ts:40</a></li></ul></aside></li></ul></section></section></div>
|
|
139
139
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
140
140
|
<div class="tsd-navigation settings">
|
|
141
141
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li><span class="target">DateTimeFormatter</span></li></ul></section><aside class="tsd-sources">
|
|
22
22
|
<ul>
|
|
23
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
23
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L14">dateTimes/DateTimeFormatter.ts:14</a></li></ul></aside>
|
|
24
24
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
25
|
<section class="tsd-panel tsd-index-panel">
|
|
26
26
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -56,14 +56,14 @@
|
|
|
56
56
|
</div></li></ul></div>
|
|
57
57
|
<h4 class="tsd-returns-title">Returns <a href="DateTimeFormatter.html" class="tsd-signature-type" data-tsd-kind="Class">DateTimeFormatter</a></h4><aside class="tsd-sources">
|
|
58
58
|
<ul>
|
|
59
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
59
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L20">dateTimes/DateTimeFormatter.ts:20</a></li></ul></aside></li></ul></section></section>
|
|
60
60
|
<section class="tsd-panel-group tsd-member-group">
|
|
61
61
|
<h2>Properties</h2>
|
|
62
62
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
|
|
63
63
|
<h3 class="tsd-anchor-link"><span>formatter</span><a href="#formatter" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
64
64
|
<div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormat</span></div><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
66
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L15">dateTimes/DateTimeFormatter.ts:15</a></li></ul></aside></section></section>
|
|
67
67
|
<section class="tsd-panel-group tsd-member-group">
|
|
68
68
|
<h2>Methods</h2>
|
|
69
69
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatDateTime" class="tsd-anchor"></a>
|
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
</div></li></ul></div>
|
|
85
85
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
86
86
|
<ul>
|
|
87
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
87
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L29">dateTimes/DateTimeFormatter.ts:29</a></li></ul></aside></li></ul></section>
|
|
88
88
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatDateTimeToParts" class="tsd-anchor"></a>
|
|
89
89
|
<h3 class="tsd-anchor-link"><span>format<wbr/>Date<wbr/>Time<wbr/>To<wbr/>Parts</span><a href="#formatDateTimeToParts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
90
90
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
</div></li></ul></div>
|
|
104
104
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DateTimeFormatPart</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
106
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L38">dateTimes/DateTimeFormatter.ts:38</a></li></ul></aside></li></ul></section>
|
|
107
107
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getStartDayOfTheWeek" class="tsd-anchor"></a>
|
|
108
108
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Start<wbr/>Day<wbr/>Of<wbr/>The<wbr/>Week</span><a href="#getStartDayOfTheWeek" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
109
109
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
</div>
|
|
116
116
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
117
117
|
<ul>
|
|
118
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
118
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L46">dateTimes/DateTimeFormatter.ts:46</a></li></ul></aside></li></ul></section></section></div>
|
|
119
119
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
120
120
|
<div class="tsd-navigation settings">
|
|
121
121
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li><span class="target">NumberFormatter</span></li></ul></section><aside class="tsd-sources">
|
|
22
22
|
<ul>
|
|
23
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
23
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L16">numbers/NumberFormatter.ts:16</a></li></ul></aside>
|
|
24
24
|
<section class="tsd-panel-group tsd-index-group">
|
|
25
25
|
<section class="tsd-panel tsd-index-panel">
|
|
26
26
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -58,19 +58,19 @@
|
|
|
58
58
|
</div></li></ul></div>
|
|
59
59
|
<h4 class="tsd-returns-title">Returns <a href="NumberFormatter.html" class="tsd-signature-type" data-tsd-kind="Class">NumberFormatter</a></h4><aside class="tsd-sources">
|
|
60
60
|
<ul>
|
|
61
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
61
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L23">numbers/NumberFormatter.ts:23</a></li></ul></aside></li></ul></section></section>
|
|
62
62
|
<section class="tsd-panel-group tsd-member-group">
|
|
63
63
|
<h2>Properties</h2>
|
|
64
64
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
|
|
65
65
|
<h3 class="tsd-anchor-link"><span>formatter</span><a href="#formatter" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
66
66
|
<div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NumberFormat</span></div><aside class="tsd-sources">
|
|
67
67
|
<ul>
|
|
68
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
68
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L17">numbers/NumberFormatter.ts:17</a></li></ul></aside></section>
|
|
69
69
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="percent" class="tsd-anchor"></a>
|
|
70
70
|
<h3 class="tsd-anchor-link"><span>percent</span><a href="#percent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
71
71
|
<div class="tsd-signature">percent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../variables/Percent-1.html" class="tsd-signature-type" data-tsd-kind="Variable">Percent</a></div><aside class="tsd-sources">
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
73
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L18">numbers/NumberFormatter.ts:18</a></li></ul></aside></section></section>
|
|
74
74
|
<section class="tsd-panel-group tsd-member-group">
|
|
75
75
|
<h2>Methods</h2>
|
|
76
76
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatNumber" class="tsd-anchor"></a>
|
|
@@ -91,7 +91,7 @@
|
|
|
91
91
|
</div></li></ul></div>
|
|
92
92
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
93
93
|
<ul>
|
|
94
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
94
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L33">numbers/NumberFormatter.ts:33</a></li></ul></aside></li></ul></section>
|
|
95
95
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatNumberToParts" class="tsd-anchor"></a>
|
|
96
96
|
<h3 class="tsd-anchor-link"><span>format<wbr/>Number<wbr/>To<wbr/>Parts</span><a href="#formatNumberToParts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
97
97
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -110,7 +110,7 @@
|
|
|
110
110
|
</div></li></ul></div>
|
|
111
111
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NumberFormatPart</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
112
112
|
<ul>
|
|
113
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
113
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L42">numbers/NumberFormatter.ts:42</a></li></ul></aside></li></ul></section>
|
|
114
114
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getNumberSeparators" class="tsd-anchor"></a>
|
|
115
115
|
<h3 class="tsd-anchor-link"><span>get<wbr/>Number<wbr/>Separators</span><a href="#getNumberSeparators" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
116
116
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
</div>
|
|
123
123
|
<h4 class="tsd-returns-title">Returns <a href="../types/Separators.html" class="tsd-signature-type" data-tsd-kind="Type alias">Separators</a></h4><aside class="tsd-sources">
|
|
124
124
|
<ul>
|
|
125
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
125
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L75">numbers/NumberFormatter.ts:75</a></li></ul></aside></li></ul></section>
|
|
126
126
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="parseNumber" class="tsd-anchor"></a>
|
|
127
127
|
<h3 class="tsd-anchor-link"><span>parse<wbr/>Number</span><a href="#parseNumber" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
128
128
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
</div></li></ul></div>
|
|
142
142
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
|
143
143
|
<ul>
|
|
144
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
144
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L53">numbers/NumberFormatter.ts:53</a></li></ul></aside></li></ul></section></section></div>
|
|
145
145
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
146
146
|
<div class="tsd-navigation settings">
|
|
147
147
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -37,7 +37,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
37
37
|
</div></li></ul></div>
|
|
38
38
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
40
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L104">numbers/CurrencyFormatter.ts:104</a></li></ul></aside></li></ul></section></div>
|
|
41
41
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
42
42
|
<div class="tsd-navigation settings">
|
|
43
43
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -77,6 +77,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
79
79
|
<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>
|
|
80
|
+
<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>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
82
83
|
<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>
|
|
@@ -93,6 +94,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|
|
95
96
|
<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>
|
|
97
|
+
<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>
|
|
96
98
|
<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>
|
|
97
99
|
<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>
|
|
98
100
|
<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>
|
|
@@ -107,6 +109,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
107
109
|
<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>
|
|
108
110
|
<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>
|
|
109
111
|
<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>
|
|
112
|
+
<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>
|
|
110
113
|
<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>
|
|
111
114
|
<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>
|
|
112
115
|
<li class="current tsd-kind-function"><a href="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>
|
|
@@ -116,6 +119,8 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
116
119
|
<li class="tsd-kind-function"><a href="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>
|
|
117
120
|
<li class="tsd-kind-function"><a href="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>
|
|
118
121
|
<li class="tsd-kind-function"><a href="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>
|
|
122
|
+
<li class="tsd-kind-function"><a href="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>
|
|
123
|
+
<li class="tsd-kind-function"><a href="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>
|
|
119
124
|
<li class="tsd-kind-function"><a href="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>
|
|
120
125
|
<li class="tsd-kind-function"><a href="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>
|
|
121
126
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -37,7 +37,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
37
37
|
</div></li></ul></div>
|
|
38
38
|
<h4 class="tsd-returns-title">Returns <a href="../types/NumberFormatPart.html" class="tsd-signature-type" data-tsd-kind="Type alias">NumberFormatPart</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
40
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/CurrencyFormatter.ts#L119">numbers/CurrencyFormatter.ts:119</a></li></ul></aside></li></ul></section></div>
|
|
41
41
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
42
42
|
<div class="tsd-navigation settings">
|
|
43
43
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -77,6 +77,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
79
79
|
<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>
|
|
80
|
+
<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>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
82
83
|
<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>
|
|
@@ -93,6 +94,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|
|
95
96
|
<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>
|
|
97
|
+
<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>
|
|
96
98
|
<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>
|
|
97
99
|
<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>
|
|
98
100
|
<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>
|
|
@@ -107,6 +109,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
107
109
|
<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>
|
|
108
110
|
<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>
|
|
109
111
|
<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>
|
|
112
|
+
<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>
|
|
110
113
|
<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>
|
|
111
114
|
<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>
|
|
112
115
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -116,6 +119,8 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
|
|
|
116
119
|
<li class="tsd-kind-function"><a href="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>
|
|
117
120
|
<li class="tsd-kind-function"><a href="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>
|
|
118
121
|
<li class="tsd-kind-function"><a href="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>
|
|
122
|
+
<li class="tsd-kind-function"><a href="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>
|
|
123
|
+
<li class="tsd-kind-function"><a href="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>
|
|
119
124
|
<li class="tsd-kind-function"><a href="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>
|
|
120
125
|
<li class="tsd-kind-function"><a href="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>
|
|
121
126
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
</div></li></ul></div>
|
|
37
37
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
38
38
|
<ul>
|
|
39
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
39
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L57">dateTimes/DateTimeFormatter.ts:57</a></li></ul></aside></li></ul></section></div>
|
|
40
40
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
41
41
|
<div class="tsd-navigation settings">
|
|
42
42
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -76,6 +76,7 @@
|
|
|
76
76
|
<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>
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
79
|
+
<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>
|
|
79
80
|
<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>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
@@ -92,6 +93,7 @@
|
|
|
92
93
|
<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>
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|
|
96
|
+
<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>
|
|
95
97
|
<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>
|
|
96
98
|
<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>
|
|
97
99
|
<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>
|
|
@@ -106,6 +108,7 @@
|
|
|
106
108
|
<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>
|
|
107
109
|
<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>
|
|
108
110
|
<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>
|
|
111
|
+
<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>
|
|
109
112
|
<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>
|
|
110
113
|
<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>
|
|
111
114
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -115,6 +118,8 @@
|
|
|
115
118
|
<li class="tsd-kind-function"><a href="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>
|
|
116
119
|
<li class="tsd-kind-function"><a href="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>
|
|
117
120
|
<li class="tsd-kind-function"><a href="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>
|
|
121
|
+
<li class="tsd-kind-function"><a href="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>
|
|
122
|
+
<li class="tsd-kind-function"><a href="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>
|
|
118
123
|
<li class="tsd-kind-function"><a href="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>
|
|
119
124
|
<li class="tsd-kind-function"><a href="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>
|
|
120
125
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
</div></li></ul></div>
|
|
37
37
|
<h4 class="tsd-returns-title">Returns <a href="../types/DateTimeFormatPart.html" class="tsd-signature-type" data-tsd-kind="Type alias">DateTimeFormatPart</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
38
38
|
<ul>
|
|
39
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
39
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/dateTimes/DateTimeFormatter.ts#L71">dateTimes/DateTimeFormatter.ts:71</a></li></ul></aside></li></ul></section></div>
|
|
40
40
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
41
41
|
<div class="tsd-navigation settings">
|
|
42
42
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -76,6 +76,7 @@
|
|
|
76
76
|
<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>
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
79
|
+
<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>
|
|
79
80
|
<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>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
@@ -92,6 +93,7 @@
|
|
|
92
93
|
<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>
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|
|
96
|
+
<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>
|
|
95
97
|
<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>
|
|
96
98
|
<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>
|
|
97
99
|
<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>
|
|
@@ -106,6 +108,7 @@
|
|
|
106
108
|
<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>
|
|
107
109
|
<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>
|
|
108
110
|
<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>
|
|
111
|
+
<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>
|
|
109
112
|
<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>
|
|
110
113
|
<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>
|
|
111
114
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -115,6 +118,8 @@
|
|
|
115
118
|
<li class="tsd-kind-function"><a href="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>
|
|
116
119
|
<li class="tsd-kind-function"><a href="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>
|
|
117
120
|
<li class="tsd-kind-function"><a href="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>
|
|
121
|
+
<li class="tsd-kind-function"><a href="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>
|
|
122
|
+
<li class="tsd-kind-function"><a href="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>
|
|
118
123
|
<li class="tsd-kind-function"><a href="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>
|
|
119
124
|
<li class="tsd-kind-function"><a href="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>
|
|
120
125
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -37,7 +37,7 @@ Intended for limited use. Consider creating a NumberFormatter object when format
|
|
|
37
37
|
</div></li></ul></div>
|
|
38
38
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/
|
|
40
|
+
<li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/f4af165/src/numbers/NumberFormatter.ts#L92">numbers/NumberFormatter.ts:92</a></li></ul></aside></li></ul></section></div>
|
|
41
41
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
42
42
|
<div class="tsd-navigation settings">
|
|
43
43
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -77,6 +77,7 @@ Intended for limited use. Consider creating a NumberFormatter object when format
|
|
|
77
77
|
<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>
|
|
78
78
|
<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>
|
|
79
79
|
<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>
|
|
80
|
+
<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>
|
|
80
81
|
<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>
|
|
81
82
|
<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>
|
|
82
83
|
<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>
|
|
@@ -93,6 +94,7 @@ Intended for limited use. Consider creating a NumberFormatter object when format
|
|
|
93
94
|
<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>
|
|
94
95
|
<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>
|
|
95
96
|
<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>
|
|
97
|
+
<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>
|
|
96
98
|
<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>
|
|
97
99
|
<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>
|
|
98
100
|
<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>
|
|
@@ -107,6 +109,7 @@ Intended for limited use. Consider creating a NumberFormatter object when format
|
|
|
107
109
|
<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>
|
|
108
110
|
<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>
|
|
109
111
|
<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>
|
|
112
|
+
<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>
|
|
110
113
|
<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>
|
|
111
114
|
<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>
|
|
112
115
|
<li class="tsd-kind-function"><a href="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>
|
|
@@ -116,6 +119,8 @@ Intended for limited use. Consider creating a NumberFormatter object when format
|
|
|
116
119
|
<li class="current tsd-kind-function"><a href="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>
|
|
117
120
|
<li class="tsd-kind-function"><a href="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>
|
|
118
121
|
<li class="tsd-kind-function"><a href="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>
|
|
122
|
+
<li class="tsd-kind-function"><a href="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>
|
|
123
|
+
<li class="tsd-kind-function"><a href="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>
|
|
119
124
|
<li class="tsd-kind-function"><a href="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>
|
|
120
125
|
<li class="tsd-kind-function"><a href="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>
|
|
121
126
|
<li class="tsd-kind-function"><a href="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>
|