@procore/globalization-toolkit 1.15.0 → 1.15.2

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.
Files changed (71) hide show
  1. package/dist/numbers/NumberFormatter.js +1 -1
  2. package/dist/numbers/NumberFormatter.js.map +1 -1
  3. package/dist/numbers/NumberUtils.d.ts +5 -2
  4. package/dist/numbers/NumberUtils.js +77 -36
  5. package/dist/numbers/NumberUtils.js.map +1 -1
  6. package/dist/tsconfig.build.tsbuildinfo +1 -1
  7. package/docs/assets/highlight.css +58 -2
  8. package/docs/assets/search.js +1 -1
  9. package/docs/assets/style.css +34 -2
  10. package/docs/classes/CurrencyFormatter.html +25 -9
  11. package/docs/classes/DateTimeFormatter.html +10 -8
  12. package/docs/classes/NumberFormatter.html +13 -11
  13. package/docs/functions/formatCurrency.html +7 -4
  14. package/docs/functions/formatCurrencyToParts.html +6 -3
  15. package/docs/functions/formatDateTime.html +6 -3
  16. package/docs/functions/formatDateTimeToParts.html +6 -3
  17. package/docs/functions/formatNumber.html +7 -4
  18. package/docs/functions/formatNumberToParts.html +6 -3
  19. package/docs/functions/getCurrencySeparators.html +121 -0
  20. package/docs/functions/getNumberSeparators.html +6 -3
  21. package/docs/functions/getStartDayOfTheWeek.html +6 -3
  22. package/docs/functions/parseCurrency.html +6 -3
  23. package/docs/functions/parseNumber.html +6 -3
  24. package/docs/index.html +191 -4
  25. package/docs/interfaces/CurrencyOptions.html +11 -9
  26. package/docs/interfaces/DateTimeOptionsBasic.html +7 -5
  27. package/docs/interfaces/DateTimeOptionsComponentsAll.html +16 -14
  28. package/docs/interfaces/DateTimeOptionsComponentsHourMinute.html +16 -14
  29. package/docs/interfaces/DateTimeOptionsComponentsHourMinuteSecond.html +16 -14
  30. package/docs/interfaces/DateTimeOptionsComponentsMonthDay.html +16 -14
  31. package/docs/interfaces/DateTimeOptionsComponentsWeekdayYearMonthDay.html +16 -14
  32. package/docs/interfaces/DateTimeOptionsComponentsYearMonth.html +16 -14
  33. package/docs/interfaces/DateTimeOptionsComponentsYearMonthDay.html +16 -14
  34. package/docs/interfaces/DateTimeOptionsStyle.html +16 -14
  35. package/docs/interfaces/NumberOptions.html +9 -7
  36. package/docs/modules.html +6 -2
  37. package/docs/types/CurrencyDisplay.html +7 -4
  38. package/docs/types/CurrencySign.html +7 -4
  39. package/docs/types/DateStyle.html +7 -4
  40. package/docs/types/DateTimeFormatPart.html +6 -3
  41. package/docs/types/DateTimeOptions.html +6 -3
  42. package/docs/types/DateTimeStyle.html +7 -4
  43. package/docs/types/Day.html +7 -4
  44. package/docs/types/FormatterOptions.html +7 -4
  45. package/docs/types/Hour.html +7 -4
  46. package/docs/types/Locale.html +6 -3
  47. package/docs/types/Minute.html +7 -4
  48. package/docs/types/Month.html +7 -4
  49. package/docs/types/NumberFormatPart.html +6 -3
  50. package/docs/types/NumericTwoDigit.html +7 -4
  51. package/docs/types/Percent.html +7 -4
  52. package/docs/types/Second.html +7 -4
  53. package/docs/types/Separators.html +7 -4
  54. package/docs/types/TimeStyle.html +7 -4
  55. package/docs/types/Weekday.html +7 -4
  56. package/docs/types/Year.html +7 -4
  57. package/docs/variables/CurrencyDisplay-1.html +8 -5
  58. package/docs/variables/CurrencySign-1.html +8 -5
  59. package/docs/variables/DateStyle-1.html +8 -5
  60. package/docs/variables/DateTimeStyle-1.html +8 -5
  61. package/docs/variables/Day-1.html +8 -5
  62. package/docs/variables/Hour-1.html +8 -5
  63. package/docs/variables/Minute-1.html +8 -5
  64. package/docs/variables/Month-1.html +8 -5
  65. package/docs/variables/NumericTwoDigit-1.html +8 -5
  66. package/docs/variables/Percent-1.html +8 -5
  67. package/docs/variables/Second-1.html +8 -5
  68. package/docs/variables/TimeStyle-1.html +8 -5
  69. package/docs/variables/Weekday-1.html +8 -5
  70. package/docs/variables/Year-1.html +8 -5
  71. package/package.json +1 -1
package/docs/classes/CurrencyFormatter.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CurrencyFormatter | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -18,7 +20,7 @@
18
20
  <ul class="tsd-hierarchy">
19
21
  <li><span class="target">CurrencyFormatter</span></li></ul></section><aside class="tsd-sources">
20
22
  <ul>
21
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L8">numbers/CurrencyFormatter.ts:8</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L7">numbers/CurrencyFormatter.ts:7</a></li></ul></aside>
22
24
  <section class="tsd-panel-group tsd-index-group">
23
25
  <section class="tsd-panel tsd-index-panel">
24
26
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,6 +38,7 @@
36
38
  <h3 class="tsd-index-heading">Methods</h3>
37
39
  <div class="tsd-index-list"><a href="CurrencyFormatter.html#formatCurrency" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></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)" id="icon-2048-text"></path></svg><span>format<wbr/>Currency</span></a>
38
40
  <a href="CurrencyFormatter.html#formatCurrencyToParts" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>format<wbr/>Currency<wbr/>To<wbr/>Parts</span></a>
41
+ <a href="CurrencyFormatter.html#getCurrencySeparators" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Currency<wbr/>Separators</span></a>
39
42
  <a href="CurrencyFormatter.html#parseCurrency" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>parse<wbr/>Currency</span></a>
40
43
  </div></section></div></details></section></section>
41
44
  <section class="tsd-panel-group tsd-member-group">
@@ -54,14 +57,14 @@
54
57
  </div></li></ul></div>
55
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">
56
59
  <ul>
57
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L14">numbers/CurrencyFormatter.ts:14</a></li></ul></aside></li></ul></section></section>
60
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L13">numbers/CurrencyFormatter.ts:13</a></li></ul></aside></li></ul></section></section>
58
61
  <section class="tsd-panel-group tsd-member-group">
59
62
  <h2>Properties</h2>
60
63
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
61
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>
62
65
  <div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NumberFormat</span></div><aside class="tsd-sources">
63
66
  <ul>
64
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L9">numbers/CurrencyFormatter.ts:9</a></li></ul></aside></section></section>
67
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L8">numbers/CurrencyFormatter.ts:8</a></li></ul></aside></section></section>
65
68
  <section class="tsd-panel-group tsd-member-group">
66
69
  <h2>Methods</h2>
67
70
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatCurrency" class="tsd-anchor"></a>
@@ -78,11 +81,11 @@
78
81
  <ul class="tsd-parameter-list">
79
82
  <li>
80
83
  <h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
81
- <div class="tsd-comment tsd-typography"><p>The value to format</p>
84
+ <div class="tsd-comment tsd-typography"><p>The value to format. Numbers larger than 15 digits should be passed as a string to maintain precision.</p>
82
85
  </div></li></ul></div>
83
86
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
84
87
  <ul>
85
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L23">numbers/CurrencyFormatter.ts:23</a></li></ul></aside></li></ul></section>
88
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L22">numbers/CurrencyFormatter.ts:22</a></li></ul></aside></li></ul></section>
86
89
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatCurrencyToParts" class="tsd-anchor"></a>
87
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>
88
91
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -101,7 +104,19 @@
101
104
  </div></li></ul></div>
102
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">
103
106
  <ul>
104
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L32">numbers/CurrencyFormatter.ts:32</a></li></ul></aside></li></ul></section>
107
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L31">numbers/CurrencyFormatter.ts:31</a></li></ul></aside></li></ul></section>
108
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCurrencySeparators" class="tsd-anchor"></a>
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
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
111
+ <li class="tsd-signature tsd-anchor-link" id="getCurrencySeparators.getCurrencySeparators-1">get<wbr/>Currency<wbr/>Separators<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/Separators.html" class="tsd-signature-type" data-tsd-kind="Type alias">Separators</a><a href="#getCurrencySeparators.getCurrencySeparators-1" 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></li>
112
+ <li class="tsd-description">
113
+ <div class="tsd-comment tsd-typography"><p>Get group and decimal separators for the Currency Options</p>
114
+
115
+ <h3>Returns</h3><p>an object containing group and decimal separators</p>
116
+ </div>
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
+ <ul>
119
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L87">numbers/CurrencyFormatter.ts:87</a></li></ul></aside></li></ul></section>
105
120
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="parseCurrency" class="tsd-anchor"></a>
106
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>
107
122
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -120,7 +135,7 @@
120
135
  </div></li></ul></div>
121
136
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
122
137
  <ul>
123
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L41">numbers/CurrencyFormatter.ts:41</a></li></ul></aside></li></ul></section></section></div>
138
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L40">numbers/CurrencyFormatter.ts:40</a></li></ul></aside></li></ul></section></section></div>
124
139
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
125
140
  <div class="tsd-navigation settings">
126
141
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -150,6 +165,7 @@
150
165
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="CurrencyFormatter.html#formatter" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>formatter</a></li>
151
166
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="CurrencyFormatter.html#formatCurrency" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>format<wbr/>Currency</a></li>
152
167
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="CurrencyFormatter.html#formatCurrencyToParts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>format<wbr/>Currency<wbr/>To<wbr/>Parts</a></li>
168
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="CurrencyFormatter.html#getCurrencySeparators" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Currency<wbr/>Separators</a></li>
153
169
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="CurrencyFormatter.html#parseCurrency" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>parse<wbr/>Currency</a></li></ul></li></ul></nav></div></div>
154
170
  <div class="container tsd-generator">
155
171
  <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
package/docs/classes/DateTimeFormatter.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DateTimeFormatter | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -18,7 +20,7 @@
18
20
  <ul class="tsd-hierarchy">
19
21
  <li><span class="target">DateTimeFormatter</span></li></ul></section><aside class="tsd-sources">
20
22
  <ul>
21
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L6">dateTimes/DateTimeFormatter.ts:6</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L6">dateTimes/DateTimeFormatter.ts:6</a></li></ul></aside>
22
24
  <section class="tsd-panel-group tsd-index-group">
23
25
  <section class="tsd-panel tsd-index-panel">
24
26
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -54,14 +56,14 @@
54
56
  </div></li></ul></div>
55
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">
56
58
  <ul>
57
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L12">dateTimes/DateTimeFormatter.ts:12</a></li></ul></aside></li></ul></section></section>
59
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L12">dateTimes/DateTimeFormatter.ts:12</a></li></ul></aside></li></ul></section></section>
58
60
  <section class="tsd-panel-group tsd-member-group">
59
61
  <h2>Properties</h2>
60
62
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
61
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>
62
64
  <div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DateTimeFormat</span></div><aside class="tsd-sources">
63
65
  <ul>
64
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L7">dateTimes/DateTimeFormatter.ts:7</a></li></ul></aside></section></section>
66
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L7">dateTimes/DateTimeFormatter.ts:7</a></li></ul></aside></section></section>
65
67
  <section class="tsd-panel-group tsd-member-group">
66
68
  <h2>Methods</h2>
67
69
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatDateTime" class="tsd-anchor"></a>
@@ -82,7 +84,7 @@
82
84
  </div></li></ul></div>
83
85
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
84
86
  <ul>
85
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L21">dateTimes/DateTimeFormatter.ts:21</a></li></ul></aside></li></ul></section>
87
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L21">dateTimes/DateTimeFormatter.ts:21</a></li></ul></aside></li></ul></section>
86
88
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatDateTimeToParts" class="tsd-anchor"></a>
87
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>
88
90
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -101,7 +103,7 @@
101
103
  </div></li></ul></div>
102
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">
103
105
  <ul>
104
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L30">dateTimes/DateTimeFormatter.ts:30</a></li></ul></aside></li></ul></section>
106
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L30">dateTimes/DateTimeFormatter.ts:30</a></li></ul></aside></li></ul></section>
105
107
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getStartDayOfTheWeek" class="tsd-anchor"></a>
106
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>
107
109
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -113,7 +115,7 @@
113
115
  </div>
114
116
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
115
117
  <ul>
116
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L38">dateTimes/DateTimeFormatter.ts:38</a></li></ul></aside></li></ul></section></section></div>
118
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L38">dateTimes/DateTimeFormatter.ts:38</a></li></ul></aside></li></ul></section></section></div>
117
119
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
118
120
  <div class="tsd-navigation settings">
119
121
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/classes/NumberFormatter.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NumberFormatter | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -18,7 +20,7 @@
18
20
  <ul class="tsd-hierarchy">
19
21
  <li><span class="target">NumberFormatter</span></li></ul></section><aside class="tsd-sources">
20
22
  <ul>
21
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L16">numbers/NumberFormatter.ts:16</a></li></ul></aside>
23
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L16">numbers/NumberFormatter.ts:16</a></li></ul></aside>
22
24
  <section class="tsd-panel-group tsd-index-group">
23
25
  <section class="tsd-panel tsd-index-panel">
24
26
  <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -56,19 +58,19 @@
56
58
  </div></li></ul></div>
57
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">
58
60
  <ul>
59
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L23">numbers/NumberFormatter.ts:23</a></li></ul></aside></li></ul></section></section>
61
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L23">numbers/NumberFormatter.ts:23</a></li></ul></aside></li></ul></section></section>
60
62
  <section class="tsd-panel-group tsd-member-group">
61
63
  <h2>Properties</h2>
62
64
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="formatter" class="tsd-anchor"></a>
63
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>
64
66
  <div class="tsd-signature">formatter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">NumberFormat</span></div><aside class="tsd-sources">
65
67
  <ul>
66
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L17">numbers/NumberFormatter.ts:17</a></li></ul></aside></section>
68
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L17">numbers/NumberFormatter.ts:17</a></li></ul></aside></section>
67
69
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="percent" class="tsd-anchor"></a>
68
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>
69
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">
70
72
  <ul>
71
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L18">numbers/NumberFormatter.ts:18</a></li></ul></aside></section></section>
73
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L18">numbers/NumberFormatter.ts:18</a></li></ul></aside></section></section>
72
74
  <section class="tsd-panel-group tsd-member-group">
73
75
  <h2>Methods</h2>
74
76
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatNumber" class="tsd-anchor"></a>
@@ -85,11 +87,11 @@
85
87
  <ul class="tsd-parameter-list">
86
88
  <li>
87
89
  <h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
88
- <div class="tsd-comment tsd-typography"><p>The value to format</p>
90
+ <div class="tsd-comment tsd-typography"><p>The value to format. Numbers larger than 15 digits should be passed as a string to maintain precision.</p>
89
91
  </div></li></ul></div>
90
92
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
91
93
  <ul>
92
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L33">numbers/NumberFormatter.ts:33</a></li></ul></aside></li></ul></section>
94
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L33">numbers/NumberFormatter.ts:33</a></li></ul></aside></li></ul></section>
93
95
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="formatNumberToParts" class="tsd-anchor"></a>
94
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>
95
97
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -108,7 +110,7 @@
108
110
  </div></li></ul></div>
109
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">
110
112
  <ul>
111
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L42">numbers/NumberFormatter.ts:42</a></li></ul></aside></li></ul></section>
113
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L42">numbers/NumberFormatter.ts:42</a></li></ul></aside></li></ul></section>
112
114
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getNumberSeparators" class="tsd-anchor"></a>
113
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>
114
116
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -120,7 +122,7 @@
120
122
  </div>
121
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">
122
124
  <ul>
123
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L75">numbers/NumberFormatter.ts:75</a></li></ul></aside></li></ul></section>
125
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L75">numbers/NumberFormatter.ts:75</a></li></ul></aside></li></ul></section>
124
126
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="parseNumber" class="tsd-anchor"></a>
125
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>
126
128
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -139,7 +141,7 @@
139
141
  </div></li></ul></div>
140
142
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
141
143
  <ul>
142
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/NumberFormatter.ts#L53">numbers/NumberFormatter.ts:53</a></li></ul></aside></li></ul></section></section></div>
144
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/NumberFormatter.ts#L53">numbers/NumberFormatter.ts:53</a></li></ul></aside></li></ul></section></section></div>
143
145
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
144
146
  <div class="tsd-navigation settings">
145
147
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
package/docs/functions/formatCurrency.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatCurrency | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -27,7 +29,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
27
29
  <ul class="tsd-parameter-list">
28
30
  <li>
29
31
  <h5>value: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
30
- <div class="tsd-comment tsd-typography"><p>The value to format</p>
32
+ <div class="tsd-comment tsd-typography"><p>The value to format. Numbers larger than 15 digits should be passed as a string to maintain precision.</p>
31
33
  </div></li>
32
34
  <li>
33
35
  <h5>currencyOptions: <a href="../interfaces/CurrencyOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CurrencyOptions</a></h5>
@@ -35,7 +37,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
35
37
  </div></li></ul></div>
36
38
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
37
39
  <ul>
38
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L92">numbers/CurrencyFormatter.ts:92</a></li></ul></aside></li></ul></section></div>
40
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L104">numbers/CurrencyFormatter.ts:104</a></li></ul></aside></li></ul></section></div>
39
41
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
40
42
  <div class="tsd-navigation settings">
41
43
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -113,6 +115,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
113
115
  <li class="tsd-kind-function"><a href="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>
114
116
  <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>
115
117
  <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
+ <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>
116
119
  <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>
117
120
  <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>
118
121
  <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>
package/docs/functions/formatCurrencyToParts.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatCurrencyToParts | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -35,7 +37,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
35
37
  </div></li></ul></div>
36
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">
37
39
  <ul>
38
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/numbers/CurrencyFormatter.ts#L107">numbers/CurrencyFormatter.ts:107</a></li></ul></aside></li></ul></section></div>
40
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/numbers/CurrencyFormatter.ts#L119">numbers/CurrencyFormatter.ts:119</a></li></ul></aside></li></ul></section></div>
39
41
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
40
42
  <div class="tsd-navigation settings">
41
43
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -113,6 +115,7 @@ Intended for limited use. Consider creating a CurrencyFormatter object when form
113
115
  <li class="tsd-kind-function"><a href="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>
114
116
  <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>
115
117
  <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
+ <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>
116
119
  <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>
117
120
  <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>
118
121
  <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>
package/docs/functions/formatDateTime.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDateTime | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -34,7 +36,7 @@
34
36
  </div></li></ul></div>
35
37
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
36
38
  <ul>
37
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L49">dateTimes/DateTimeFormatter.ts:49</a></li></ul></aside></li></ul></section></div>
39
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L49">dateTimes/DateTimeFormatter.ts:49</a></li></ul></aside></li></ul></section></div>
38
40
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
39
41
  <div class="tsd-navigation settings">
40
42
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -112,6 +114,7 @@
112
114
  <li class="tsd-kind-function"><a href="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>
113
115
  <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>
114
116
  <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
+ <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>
115
118
  <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>
116
119
  <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>
117
120
  <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>
package/docs/functions/formatDateTimeToParts.html CHANGED
@@ -1,11 +1,13 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>formatDateTimeToParts | @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
2
  <div class="tsd-toolbar-contents container">
3
3
  <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget 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>
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>
5
7
  <ul class="results">
6
8
  <li class="state loading">Preparing search index...</li>
7
9
  <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@procore/globalization-toolkit</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget 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>
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>
9
11
  <div class="container container-main">
10
12
  <div class="col-8 col-content">
11
13
  <div class="tsd-page-title">
@@ -34,7 +36,7 @@
34
36
  </div></li></ul></div>
35
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">
36
38
  <ul>
37
- <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/e656fa8/src/dateTimes/DateTimeFormatter.ts#L63">dateTimes/DateTimeFormatter.ts:63</a></li></ul></aside></li></ul></section></div>
39
+ <li>Defined in <a href="https://github.com/procore/globalization-toolkit/blob/9bd129c/src/dateTimes/DateTimeFormatter.ts#L63">dateTimes/DateTimeFormatter.ts:63</a></li></ul></aside></li></ul></section></div>
38
40
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
39
41
  <div class="tsd-navigation settings">
40
42
  <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -112,6 +114,7 @@
112
114
  <li class="current tsd-kind-function"><a href="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>
113
115
  <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>
114
116
  <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
+ <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>
115
118
  <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>
116
119
  <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>
117
120
  <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>