@photostructure/fs-metadata 0.5.0 → 0.6.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.
Files changed (116) hide show
  1. package/C++_REVIEW_TODO.md +1 -1
  2. package/CHANGELOG.md +11 -1
  3. package/CLAUDE.md +30 -23
  4. package/CONTRIBUTING.md +41 -0
  5. package/binding.gyp +2 -1
  6. package/dist/index.cjs +1439 -0
  7. package/dist/index.cjs.map +1 -0
  8. package/dist/index.d.cts +360 -0
  9. package/dist/index.d.mts +360 -0
  10. package/dist/index.d.ts +360 -0
  11. package/dist/index.mjs +1397 -0
  12. package/dist/index.mjs.map +1 -0
  13. package/package.json +19 -22
  14. package/prebuilds/darwin-arm64/@photostructure+fs-metadata.glibc.node +0 -0
  15. package/prebuilds/linux-arm64/@photostructure+fs-metadata.musl.node +0 -0
  16. package/prebuilds/linux-x64/@photostructure+fs-metadata.glibc.node +0 -0
  17. package/prebuilds/linux-x64/@photostructure+fs-metadata.musl.node +0 -0
  18. package/prebuilds/win32-x64/@photostructure+fs-metadata.glibc.node +0 -0
  19. package/scripts/check-memory.mjs +53 -173
  20. package/scripts/clang-tidy.mjs +1 -1
  21. package/scripts/sanitizers-test.sh +151 -0
  22. package/scripts/valgrind-test.mjs +1 -1
  23. package/scripts/{valgrind.sh → valgrind-test.sh} +15 -0
  24. package/src/common/error_utils.h +23 -0
  25. package/src/common/metadata_worker.h +4 -1
  26. package/src/darwin/hidden.cpp +13 -6
  27. package/src/darwin/volume_metadata.cpp +2 -2
  28. package/src/darwin/volume_mount_points.cpp +8 -1
  29. package/src/linux/blkid_cache.cpp +8 -2
  30. package/src/linux/volume_metadata.cpp +1 -1
  31. package/src/test-utils/worker-thread-helper.cjs +88 -0
  32. package/src/windows/hidden.cpp +20 -11
  33. package/coverage/base.css +0 -224
  34. package/coverage/block-navigation.js +0 -87
  35. package/coverage/favicon.png +0 -0
  36. package/coverage/index.html +0 -131
  37. package/coverage/lcov-report/base.css +0 -224
  38. package/coverage/lcov-report/block-navigation.js +0 -87
  39. package/coverage/lcov-report/favicon.png +0 -0
  40. package/coverage/lcov-report/index.html +0 -131
  41. package/coverage/lcov-report/prettify.css +0 -1
  42. package/coverage/lcov-report/prettify.js +0 -2
  43. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  44. package/coverage/lcov-report/sorter.js +0 -196
  45. package/coverage/lcov-report/src/array.ts.html +0 -217
  46. package/coverage/lcov-report/src/async.ts.html +0 -547
  47. package/coverage/lcov-report/src/debuglog.ts.html +0 -187
  48. package/coverage/lcov-report/src/defer.ts.html +0 -175
  49. package/coverage/lcov-report/src/dirname.ts.html +0 -124
  50. package/coverage/lcov-report/src/error.ts.html +0 -322
  51. package/coverage/lcov-report/src/fs.ts.html +0 -316
  52. package/coverage/lcov-report/src/glob.ts.html +0 -472
  53. package/coverage/lcov-report/src/hidden.ts.html +0 -724
  54. package/coverage/lcov-report/src/index.html +0 -521
  55. package/coverage/lcov-report/src/index.ts.html +0 -676
  56. package/coverage/lcov-report/src/linux/dev_disk.ts.html +0 -316
  57. package/coverage/lcov-report/src/linux/index.html +0 -146
  58. package/coverage/lcov-report/src/linux/mount_points.ts.html +0 -364
  59. package/coverage/lcov-report/src/linux/mtab.ts.html +0 -493
  60. package/coverage/lcov-report/src/mount_point.ts.html +0 -106
  61. package/coverage/lcov-report/src/number.ts.html +0 -148
  62. package/coverage/lcov-report/src/object.ts.html +0 -265
  63. package/coverage/lcov-report/src/options.ts.html +0 -475
  64. package/coverage/lcov-report/src/path.ts.html +0 -268
  65. package/coverage/lcov-report/src/platform.ts.html +0 -112
  66. package/coverage/lcov-report/src/random.ts.html +0 -205
  67. package/coverage/lcov-report/src/remote_info.ts.html +0 -553
  68. package/coverage/lcov-report/src/stack_path.ts.html +0 -298
  69. package/coverage/lcov-report/src/string.ts.html +0 -382
  70. package/coverage/lcov-report/src/string_enum.ts.html +0 -208
  71. package/coverage/lcov-report/src/system_volume.ts.html +0 -301
  72. package/coverage/lcov-report/src/unc.ts.html +0 -274
  73. package/coverage/lcov-report/src/units.ts.html +0 -274
  74. package/coverage/lcov-report/src/uuid.ts.html +0 -157
  75. package/coverage/lcov-report/src/volume_health_status.ts.html +0 -259
  76. package/coverage/lcov-report/src/volume_metadata.ts.html +0 -787
  77. package/coverage/lcov-report/src/volume_mount_points.ts.html +0 -388
  78. package/coverage/lcov.info +0 -3581
  79. package/coverage/prettify.css +0 -1
  80. package/coverage/prettify.js +0 -2
  81. package/coverage/sort-arrow-sprite.png +0 -0
  82. package/coverage/sorter.js +0 -196
  83. package/coverage/src/array.ts.html +0 -217
  84. package/coverage/src/async.ts.html +0 -547
  85. package/coverage/src/debuglog.ts.html +0 -187
  86. package/coverage/src/defer.ts.html +0 -175
  87. package/coverage/src/dirname.ts.html +0 -124
  88. package/coverage/src/error.ts.html +0 -322
  89. package/coverage/src/fs.ts.html +0 -316
  90. package/coverage/src/glob.ts.html +0 -472
  91. package/coverage/src/hidden.ts.html +0 -724
  92. package/coverage/src/index.html +0 -521
  93. package/coverage/src/index.ts.html +0 -676
  94. package/coverage/src/linux/dev_disk.ts.html +0 -316
  95. package/coverage/src/linux/index.html +0 -146
  96. package/coverage/src/linux/mount_points.ts.html +0 -364
  97. package/coverage/src/linux/mtab.ts.html +0 -493
  98. package/coverage/src/mount_point.ts.html +0 -106
  99. package/coverage/src/number.ts.html +0 -148
  100. package/coverage/src/object.ts.html +0 -265
  101. package/coverage/src/options.ts.html +0 -475
  102. package/coverage/src/path.ts.html +0 -268
  103. package/coverage/src/platform.ts.html +0 -112
  104. package/coverage/src/random.ts.html +0 -205
  105. package/coverage/src/remote_info.ts.html +0 -553
  106. package/coverage/src/stack_path.ts.html +0 -298
  107. package/coverage/src/string.ts.html +0 -382
  108. package/coverage/src/string_enum.ts.html +0 -208
  109. package/coverage/src/system_volume.ts.html +0 -301
  110. package/coverage/src/unc.ts.html +0 -274
  111. package/coverage/src/units.ts.html +0 -274
  112. package/coverage/src/uuid.ts.html +0 -157
  113. package/coverage/src/volume_health_status.ts.html +0 -259
  114. package/coverage/src/volume_metadata.ts.html +0 -787
  115. package/coverage/src/volume_mount_points.ts.html +0 -388
  116. package/scripts/run-asan.sh +0 -92
package/coverage/src/string.ts.html DELETED
@@ -1,382 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for src/string.ts</title>
7
- <meta charset="utf-8" />
8
- <link rel="stylesheet" href="../prettify.css" />
9
- <link rel="stylesheet" href="../base.css" />
10
- <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
- <meta name="viewport" content="width=device-width, initial-scale=1" />
12
- <style type='text/css'>
13
- .coverage-summary .sorter {
14
- background-image: url(../sort-arrow-sprite.png);
15
- }
16
- </style>
17
- </head>
18
-
19
- <body>
20
- <div class='wrapper'>
21
- <div class='pad1'>
22
- <h1><a href="../index.html">All files</a> / <a href="index.html">src</a> string.ts</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">96.96% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>96/99</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">96% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>24/25</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">100% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>9/9</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">96.96% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>96/99</span>
50
- </div>
51
-
52
-
53
- </div>
54
- <p class="quiet">
55
- Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
- </p>
57
- <template id="filterTemplate">
58
- <div class="quiet">
59
- Filter:
60
- <input type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line high'></div>
65
- <pre><table class="coverage">
66
- <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
- <a name='L2'></a><a href='#L2'>2</a>
68
- <a name='L3'></a><a href='#L3'>3</a>
69
- <a name='L4'></a><a href='#L4'>4</a>
70
- <a name='L5'></a><a href='#L5'>5</a>
71
- <a name='L6'></a><a href='#L6'>6</a>
72
- <a name='L7'></a><a href='#L7'>7</a>
73
- <a name='L8'></a><a href='#L8'>8</a>
74
- <a name='L9'></a><a href='#L9'>9</a>
75
- <a name='L10'></a><a href='#L10'>10</a>
76
- <a name='L11'></a><a href='#L11'>11</a>
77
- <a name='L12'></a><a href='#L12'>12</a>
78
- <a name='L13'></a><a href='#L13'>13</a>
79
- <a name='L14'></a><a href='#L14'>14</a>
80
- <a name='L15'></a><a href='#L15'>15</a>
81
- <a name='L16'></a><a href='#L16'>16</a>
82
- <a name='L17'></a><a href='#L17'>17</a>
83
- <a name='L18'></a><a href='#L18'>18</a>
84
- <a name='L19'></a><a href='#L19'>19</a>
85
- <a name='L20'></a><a href='#L20'>20</a>
86
- <a name='L21'></a><a href='#L21'>21</a>
87
- <a name='L22'></a><a href='#L22'>22</a>
88
- <a name='L23'></a><a href='#L23'>23</a>
89
- <a name='L24'></a><a href='#L24'>24</a>
90
- <a name='L25'></a><a href='#L25'>25</a>
91
- <a name='L26'></a><a href='#L26'>26</a>
92
- <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a>
94
- <a name='L29'></a><a href='#L29'>29</a>
95
- <a name='L30'></a><a href='#L30'>30</a>
96
- <a name='L31'></a><a href='#L31'>31</a>
97
- <a name='L32'></a><a href='#L32'>32</a>
98
- <a name='L33'></a><a href='#L33'>33</a>
99
- <a name='L34'></a><a href='#L34'>34</a>
100
- <a name='L35'></a><a href='#L35'>35</a>
101
- <a name='L36'></a><a href='#L36'>36</a>
102
- <a name='L37'></a><a href='#L37'>37</a>
103
- <a name='L38'></a><a href='#L38'>38</a>
104
- <a name='L39'></a><a href='#L39'>39</a>
105
- <a name='L40'></a><a href='#L40'>40</a>
106
- <a name='L41'></a><a href='#L41'>41</a>
107
- <a name='L42'></a><a href='#L42'>42</a>
108
- <a name='L43'></a><a href='#L43'>43</a>
109
- <a name='L44'></a><a href='#L44'>44</a>
110
- <a name='L45'></a><a href='#L45'>45</a>
111
- <a name='L46'></a><a href='#L46'>46</a>
112
- <a name='L47'></a><a href='#L47'>47</a>
113
- <a name='L48'></a><a href='#L48'>48</a>
114
- <a name='L49'></a><a href='#L49'>49</a>
115
- <a name='L50'></a><a href='#L50'>50</a>
116
- <a name='L51'></a><a href='#L51'>51</a>
117
- <a name='L52'></a><a href='#L52'>52</a>
118
- <a name='L53'></a><a href='#L53'>53</a>
119
- <a name='L54'></a><a href='#L54'>54</a>
120
- <a name='L55'></a><a href='#L55'>55</a>
121
- <a name='L56'></a><a href='#L56'>56</a>
122
- <a name='L57'></a><a href='#L57'>57</a>
123
- <a name='L58'></a><a href='#L58'>58</a>
124
- <a name='L59'></a><a href='#L59'>59</a>
125
- <a name='L60'></a><a href='#L60'>60</a>
126
- <a name='L61'></a><a href='#L61'>61</a>
127
- <a name='L62'></a><a href='#L62'>62</a>
128
- <a name='L63'></a><a href='#L63'>63</a>
129
- <a name='L64'></a><a href='#L64'>64</a>
130
- <a name='L65'></a><a href='#L65'>65</a>
131
- <a name='L66'></a><a href='#L66'>66</a>
132
- <a name='L67'></a><a href='#L67'>67</a>
133
- <a name='L68'></a><a href='#L68'>68</a>
134
- <a name='L69'></a><a href='#L69'>69</a>
135
- <a name='L70'></a><a href='#L70'>70</a>
136
- <a name='L71'></a><a href='#L71'>71</a>
137
- <a name='L72'></a><a href='#L72'>72</a>
138
- <a name='L73'></a><a href='#L73'>73</a>
139
- <a name='L74'></a><a href='#L74'>74</a>
140
- <a name='L75'></a><a href='#L75'>75</a>
141
- <a name='L76'></a><a href='#L76'>76</a>
142
- <a name='L77'></a><a href='#L77'>77</a>
143
- <a name='L78'></a><a href='#L78'>78</a>
144
- <a name='L79'></a><a href='#L79'>79</a>
145
- <a name='L80'></a><a href='#L80'>80</a>
146
- <a name='L81'></a><a href='#L81'>81</a>
147
- <a name='L82'></a><a href='#L82'>82</a>
148
- <a name='L83'></a><a href='#L83'>83</a>
149
- <a name='L84'></a><a href='#L84'>84</a>
150
- <a name='L85'></a><a href='#L85'>85</a>
151
- <a name='L86'></a><a href='#L86'>86</a>
152
- <a name='L87'></a><a href='#L87'>87</a>
153
- <a name='L88'></a><a href='#L88'>88</a>
154
- <a name='L89'></a><a href='#L89'>89</a>
155
- <a name='L90'></a><a href='#L90'>90</a>
156
- <a name='L91'></a><a href='#L91'>91</a>
157
- <a name='L92'></a><a href='#L92'>92</a>
158
- <a name='L93'></a><a href='#L93'>93</a>
159
- <a name='L94'></a><a href='#L94'>94</a>
160
- <a name='L95'></a><a href='#L95'>95</a>
161
- <a name='L96'></a><a href='#L96'>96</a>
162
- <a name='L97'></a><a href='#L97'>97</a>
163
- <a name='L98'></a><a href='#L98'>98</a>
164
- <a name='L99'></a><a href='#L99'>99</a>
165
- <a name='L100'></a><a href='#L100'>100</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
166
- <span class="cline-any cline-yes">1x</span>
167
- <span class="cline-any cline-yes">7791x</span>
168
- <span class="cline-any cline-yes">7791x</span>
169
- <span class="cline-any cline-yes">7791x</span>
170
- <span class="cline-any cline-yes">1x</span>
171
- <span class="cline-any cline-yes">80x</span>
172
- <span class="cline-any cline-yes">80x</span>
173
- <span class="cline-any cline-yes">80x</span>
174
- <span class="cline-any cline-yes">1x</span>
175
- <span class="cline-any cline-yes">1x</span>
176
- <span class="cline-any cline-yes">1x</span>
177
- <span class="cline-any cline-yes">1x</span>
178
- <span class="cline-any cline-yes">22354x</span>
179
- <span class="cline-any cline-yes">22354x</span>
180
- <span class="cline-any cline-yes">22354x</span>
181
- <span class="cline-any cline-yes">1x</span>
182
- <span class="cline-any cline-yes">1x</span>
183
- <span class="cline-any cline-yes">1x</span>
184
- <span class="cline-any cline-yes">1x</span>
185
- <span class="cline-any cline-yes">8771x</span>
186
- <span class="cline-any cline-yes">8771x</span>
187
- <span class="cline-any cline-yes">8771x</span>
188
- <span class="cline-any cline-yes">1x</span>
189
- <span class="cline-any cline-yes">1654x</span>
190
- <span class="cline-any cline-yes">1654x</span>
191
- <span class="cline-any cline-yes">1654x</span>
192
- <span class="cline-any cline-yes">1x</span>
193
- <span class="cline-any cline-yes">1x</span>
194
- <span class="cline-any cline-yes">1x</span>
195
- <span class="cline-any cline-yes">1x</span>
196
- <span class="cline-any cline-yes">1x</span>
197
- <span class="cline-any cline-yes">1x</span>
198
- <span class="cline-any cline-yes">1x</span>
199
- <span class="cline-any cline-yes">1x</span>
200
- <span class="cline-any cline-yes">1x</span>
201
- <span class="cline-any cline-yes">18187x</span>
202
- <span class="cline-any cline-yes">18187x</span>
203
- <span class="cline-any cline-yes">18187x</span>
204
- <span class="cline-any cline-yes">18187x</span>
205
- <span class="cline-any cline-yes">89x</span>
206
- <span class="cline-any cline-yes">89x</span>
207
- <span class="cline-any cline-yes">86x</span>
208
- <span class="cline-any cline-yes">86x</span>
209
- <span class="cline-any cline-yes">3x</span>
210
- <span class="cline-any cline-yes">3x</span>
211
- <span class="cline-any cline-yes">3x</span>
212
- <span class="cline-any cline-yes">3x</span>
213
- <span class="cline-any cline-yes">3x</span>
214
- <span class="cline-any cline-no">&nbsp;</span>
215
- <span class="cline-any cline-no">&nbsp;</span>
216
- <span class="cline-any cline-no">&nbsp;</span>
217
- <span class="cline-any cline-yes">18187x</span>
218
- <span class="cline-any cline-yes">18187x</span>
219
- <span class="cline-any cline-yes">1x</span>
220
- <span class="cline-any cline-yes">1x</span>
221
- <span class="cline-any cline-yes">1x</span>
222
- <span class="cline-any cline-yes">7x</span>
223
- <span class="cline-any cline-yes">7x</span>
224
- <span class="cline-any cline-yes">7x</span>
225
- <span class="cline-any cline-yes">7x</span>
226
- <span class="cline-any cline-yes">73x</span>
227
- <span class="cline-any cline-yes">73x</span>
228
- <span class="cline-any cline-yes">73x</span>
229
- <span class="cline-any cline-yes">73x</span>
230
- <span class="cline-any cline-yes">7x</span>
231
- <span class="cline-any cline-yes">7x</span>
232
- <span class="cline-any cline-yes">7x</span>
233
- <span class="cline-any cline-yes">1x</span>
234
- <span class="cline-any cline-yes">1x</span>
235
- <span class="cline-any cline-yes">1x</span>
236
- <span class="cline-any cline-yes">1x</span>
237
- <span class="cline-any cline-yes">1x</span>
238
- <span class="cline-any cline-yes">1x</span>
239
- <span class="cline-any cline-yes">1x</span>
240
- <span class="cline-any cline-yes">2x</span>
241
- <span class="cline-any cline-yes">2x</span>
242
- <span class="cline-any cline-yes">2x</span>
243
- <span class="cline-any cline-yes">2x</span>
244
- <span class="cline-any cline-yes">2x</span>
245
- <span class="cline-any cline-yes">2x</span>
246
- <span class="cline-any cline-yes">2x</span>
247
- <span class="cline-any cline-yes">1x</span>
248
- <span class="cline-any cline-yes">1x</span>
249
- <span class="cline-any cline-yes">1x</span>
250
- <span class="cline-any cline-yes">1x</span>
251
- <span class="cline-any cline-yes">1x</span>
252
- <span class="cline-any cline-yes">1x</span>
253
- <span class="cline-any cline-yes">1x</span>
254
- <span class="cline-any cline-yes">1x</span>
255
- <span class="cline-any cline-yes">1x</span>
256
- <span class="cline-any cline-yes">20x</span>
257
- <span class="cline-any cline-yes">20x</span>
258
- <span class="cline-any cline-yes">20x</span>
259
- <span class="cline-any cline-yes">20x</span>
260
- <span class="cline-any cline-yes">20x</span>
261
- <span class="cline-any cline-yes">20x</span>
262
- <span class="cline-any cline-yes">20x</span>
263
- <span class="cline-any cline-yes">20x</span>
264
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// src/string.ts
265
- &nbsp;
266
- export function isString(input: unknown): input is string {
267
- return typeof input === "string";
268
- }
269
- &nbsp;
270
- export function toS(input: unknown): string {
271
- return isString(input) ? input : input == null ? "" : String(input);
272
- }
273
- &nbsp;
274
- /**
275
- * @return true iff the input is a string and has at least one non-whitespace character
276
- */
277
- export function isNotBlank(input: unknown): input is string {
278
- return typeof input === "string" &amp;&amp; input.trim().length &gt; 0;
279
- }
280
- &nbsp;
281
- /**
282
- * @return true iff the input is not a string or only has non-whitespace characters
283
- */
284
- export function isBlank(input: unknown): input is undefined {
285
- return !isNotBlank(input);
286
- }
287
- &nbsp;
288
- export function toNotBlank(input: unknown): string | undefined {
289
- return isNotBlank(input) ? input : undefined;
290
- }
291
- &nbsp;
292
- /**
293
- * Decodes a string containing octal (\000-\377) and/or hexadecimal
294
- * (\x00-\xFF) escape sequences
295
- * @param input The string containing escape sequences to decode
296
- * @returns The decoded string with escape sequences converted to their
297
- * corresponding characters
298
- * @throws Error if an invalid escape sequence is encountered
299
- */
300
- export function decodeEscapeSequences(input: string): string {
301
- const escapeRegex = /\\(?:([0-7]{2,6})|x([0-9a-fA-F]{2,4}))/g;
302
- &nbsp;
303
- return input.replace(escapeRegex, (match, octal, hex) =&gt; {
304
- // Handle octal escape sequences
305
- if (octal != null) {
306
- return String.fromCharCode(parseInt(octal, 8));
307
- }
308
- &nbsp;
309
- // Handle hexadecimal escape sequences
310
- if (hex != null) {
311
- return String.fromCharCode(parseInt(hex, 16));
312
- }
313
- <span class="cstat-no" title="statement not covered" ><span class="branch-0 cbranch-no" title="branch not covered" ></span></span>
314
- <span class="cstat-no" title="statement not covered" > // This should never happen due to the regex pattern</span>
315
- <span class="cstat-no" title="statement not covered" > throw new Error(`Invalid escape sequence: ${match}`);</span>
316
- });
317
- }
318
- &nbsp;
319
- const AlphaNumericRE = /[/\w.-]/;
320
- &nbsp;
321
- export function encodeEscapeSequences(input: string): string {
322
- return input
323
- .split("")
324
- .map((char) =&gt; {
325
- const encodedChar = AlphaNumericRE.test(char)
326
- ? char
327
- : "\\" + char.charCodeAt(0).toString(8).padStart(2, "0");
328
- return encodedChar;
329
- })
330
- .join("");
331
- }
332
- &nbsp;
333
- /**
334
- * Sort an array of strings using the locale-aware collation algorithm.
335
- *
336
- * @param arr The array of strings to sort. The original array **is sorted in
337
- * place**.
338
- */
339
- export function sortByLocale(
340
- arr: string[],
341
- locales?: Intl.LocalesArgument,
342
- options?: Intl.CollatorOptions,
343
- ): string[] {
344
- return arr.sort((a, b) =&gt; a.localeCompare(b, locales, options));
345
- }
346
- &nbsp;
347
- /**
348
- * Sort an array of objects using the locale-aware collation algorithm.
349
- *
350
- * @param arr The array of objects to sort.
351
- * @param fn The function to extract the key to sort by from each object.
352
- * @param locales The locales to use for sorting.
353
- * @param options The collation options to use for sorting.
354
- */
355
- export function sortObjectsByLocale&lt;T&gt;(
356
- arr: T[],
357
- fn: (key: T) =&gt; string,
358
- locales?: Intl.LocalesArgument,
359
- options?: Intl.CollatorOptions,
360
- ): T[] {
361
- return arr.sort((a, b) =&gt; fn(a).localeCompare(fn(b), locales, options));
362
- }
363
- &nbsp;</pre></td></tr></table></pre>
364
-
365
- <div class='push'></div><!-- for sticky footer -->
366
- </div><!-- /wrapper -->
367
- <div class='footer quiet pad2 space-top1 center small'>
368
- Code coverage generated by
369
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
370
- at 2025-06-01T20:18:02.872Z
371
- </div>
372
- <script src="../prettify.js"></script>
373
- <script>
374
- window.onload = function () {
375
- prettyPrint();
376
- };
377
- </script>
378
- <script src="../sorter.js"></script>
379
- <script src="../block-navigation.js"></script>
380
- </body>
381
- </html>
382
-
package/coverage/src/string_enum.ts.html DELETED
@@ -1,208 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for src/string_enum.ts</title>
7
- <meta charset="utf-8" />
8
- <link rel="stylesheet" href="../prettify.css" />
9
- <link rel="stylesheet" href="../base.css" />
10
- <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
- <meta name="viewport" content="width=device-width, initial-scale=1" />
12
- <style type='text/css'>
13
- .coverage-summary .sorter {
14
- background-image: url(../sort-arrow-sprite.png);
15
- }
16
- </style>
17
- </head>
18
-
19
- <body>
20
- <div class='wrapper'>
21
- <div class='pad1'>
22
- <h1><a href="../index.html">All files</a> / <a href="index.html">src</a> string_enum.ts</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">100% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>41/41</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">100% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>6/6</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">100% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>2/2</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">100% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>41/41</span>
50
- </div>
51
-
52
-
53
- </div>
54
- <p class="quiet">
55
- Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
- </p>
57
- <template id="filterTemplate">
58
- <div class="quiet">
59
- Filter:
60
- <input type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line high'></div>
65
- <pre><table class="coverage">
66
- <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
- <a name='L2'></a><a href='#L2'>2</a>
68
- <a name='L3'></a><a href='#L3'>3</a>
69
- <a name='L4'></a><a href='#L4'>4</a>
70
- <a name='L5'></a><a href='#L5'>5</a>
71
- <a name='L6'></a><a href='#L6'>6</a>
72
- <a name='L7'></a><a href='#L7'>7</a>
73
- <a name='L8'></a><a href='#L8'>8</a>
74
- <a name='L9'></a><a href='#L9'>9</a>
75
- <a name='L10'></a><a href='#L10'>10</a>
76
- <a name='L11'></a><a href='#L11'>11</a>
77
- <a name='L12'></a><a href='#L12'>12</a>
78
- <a name='L13'></a><a href='#L13'>13</a>
79
- <a name='L14'></a><a href='#L14'>14</a>
80
- <a name='L15'></a><a href='#L15'>15</a>
81
- <a name='L16'></a><a href='#L16'>16</a>
82
- <a name='L17'></a><a href='#L17'>17</a>
83
- <a name='L18'></a><a href='#L18'>18</a>
84
- <a name='L19'></a><a href='#L19'>19</a>
85
- <a name='L20'></a><a href='#L20'>20</a>
86
- <a name='L21'></a><a href='#L21'>21</a>
87
- <a name='L22'></a><a href='#L22'>22</a>
88
- <a name='L23'></a><a href='#L23'>23</a>
89
- <a name='L24'></a><a href='#L24'>24</a>
90
- <a name='L25'></a><a href='#L25'>25</a>
91
- <a name='L26'></a><a href='#L26'>26</a>
92
- <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a>
94
- <a name='L29'></a><a href='#L29'>29</a>
95
- <a name='L30'></a><a href='#L30'>30</a>
96
- <a name='L31'></a><a href='#L31'>31</a>
97
- <a name='L32'></a><a href='#L32'>32</a>
98
- <a name='L33'></a><a href='#L33'>33</a>
99
- <a name='L34'></a><a href='#L34'>34</a>
100
- <a name='L35'></a><a href='#L35'>35</a>
101
- <a name='L36'></a><a href='#L36'>36</a>
102
- <a name='L37'></a><a href='#L37'>37</a>
103
- <a name='L38'></a><a href='#L38'>38</a>
104
- <a name='L39'></a><a href='#L39'>39</a>
105
- <a name='L40'></a><a href='#L40'>40</a>
106
- <a name='L41'></a><a href='#L41'>41</a>
107
- <a name='L42'></a><a href='#L42'>42</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
108
- <span class="cline-any cline-yes">1x</span>
109
- <span class="cline-any cline-yes">1x</span>
110
- <span class="cline-any cline-yes">1x</span>
111
- <span class="cline-any cline-yes">1x</span>
112
- <span class="cline-any cline-yes">1x</span>
113
- <span class="cline-any cline-yes">1x</span>
114
- <span class="cline-any cline-yes">1x</span>
115
- <span class="cline-any cline-yes">1x</span>
116
- <span class="cline-any cline-yes">1x</span>
117
- <span class="cline-any cline-yes">1x</span>
118
- <span class="cline-any cline-yes">1x</span>
119
- <span class="cline-any cline-yes">1x</span>
120
- <span class="cline-any cline-yes">1x</span>
121
- <span class="cline-any cline-yes">1x</span>
122
- <span class="cline-any cline-yes">1x</span>
123
- <span class="cline-any cline-yes">1x</span>
124
- <span class="cline-any cline-yes">1x</span>
125
- <span class="cline-any cline-yes">1x</span>
126
- <span class="cline-any cline-yes">1x</span>
127
- <span class="cline-any cline-yes">1x</span>
128
- <span class="cline-any cline-yes">1x</span>
129
- <span class="cline-any cline-yes">1x</span>
130
- <span class="cline-any cline-yes">1x</span>
131
- <span class="cline-any cline-yes">1x</span>
132
- <span class="cline-any cline-yes">16x</span>
133
- <span class="cline-any cline-yes">16x</span>
134
- <span class="cline-any cline-yes">16x</span>
135
- <span class="cline-any cline-yes">16x</span>
136
- <span class="cline-any cline-yes">16x</span>
137
- <span class="cline-any cline-yes">55x</span>
138
- <span class="cline-any cline-yes">55x</span>
139
- <span class="cline-any cline-yes">16x</span>
140
- <span class="cline-any cline-yes">16x</span>
141
- <span class="cline-any cline-yes">16x</span>
142
- <span class="cline-any cline-yes">16x</span>
143
- <span class="cline-any cline-yes">16x</span>
144
- <span class="cline-any cline-yes">16x</span>
145
- <span class="cline-any cline-yes">16x</span>
146
- <span class="cline-any cline-yes">16x</span>
147
- <span class="cline-any cline-yes">16x</span>
148
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// src/string_enum.ts
149
- &nbsp;
150
- // See https://basarat.gitbooks.io/typescript/content/docs/types/literal-types.html
151
- &nbsp;
152
- export type StringEnumType&lt;T extends string&gt; = {
153
- [K in T]: K;
154
- };
155
- &nbsp;
156
- export type StringEnum&lt;T extends string&gt; = StringEnumType&lt;T&gt; &amp; {
157
- values: T[];
158
- size: number;
159
- get(s: string | undefined): T | undefined;
160
- };
161
- &nbsp;
162
- export type StringEnumKeys&lt;Type&gt; = Type extends StringEnum&lt;infer X&gt; ? X : never;
163
- &nbsp;
164
- /**
165
- * Create a string enum with the given values.
166
- &nbsp;
167
- Example usage:
168
- &nbsp;
169
- export const Directions = stringEnum("North", "South", "East", "West")
170
- export type Direction = StringEnumKeys&lt;typeof Directions&gt;
171
- &nbsp;
172
- */
173
- export function stringEnum&lt;T extends string&gt;(...o: T[]): StringEnum&lt;T&gt; {
174
- const set = new Set(o);
175
- &nbsp;
176
- const dict: StringEnumType&lt;T&gt; = {} as StringEnumType&lt;T&gt;;
177
- for (const key of o) {
178
- dict[key] = key;
179
- }
180
- &nbsp;
181
- return {
182
- ...dict,
183
- values: Object.freeze([...set]) as T[],
184
- size: set.size,
185
- get: (s: string | undefined) =&gt;
186
- s != null &amp;&amp; set.has(s as T) ? (s as T) : undefined,
187
- };
188
- }
189
- &nbsp;</pre></td></tr></table></pre>
190
-
191
- <div class='push'></div><!-- for sticky footer -->
192
- </div><!-- /wrapper -->
193
- <div class='footer quiet pad2 space-top1 center small'>
194
- Code coverage generated by
195
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
196
- at 2025-06-01T20:18:02.872Z
197
- </div>
198
- <script src="../prettify.js"></script>
199
- <script>
200
- window.onload = function () {
201
- prettyPrint();
202
- };
203
- </script>
204
- <script src="../sorter.js"></script>
205
- <script src="../block-navigation.js"></script>
206
- </body>
207
- </html>
208
-