@nickyzj2023/utils 1.0.16 → 1.0.18

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 (40) hide show
  1. package/README.md +35 -35
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.js +1 -1
  4. package/dist/is.d.ts +2 -1
  5. package/dist/object.d.ts +35 -0
  6. package/dist/string.d.ts +14 -0
  7. package/docs/assets/material-style.css +262 -0
  8. package/docs/assets/navigation.js +1 -1
  9. package/docs/assets/search.js +1 -1
  10. package/docs/functions/camelToSnake.html +178 -0
  11. package/docs/functions/fetcher.html +175 -2
  12. package/docs/functions/isObject.html +175 -2
  13. package/docs/functions/isPrimitive.html +176 -3
  14. package/docs/functions/mapKeys.html +180 -0
  15. package/docs/functions/mapValues.html +181 -0
  16. package/docs/functions/mergeObjects.html +175 -2
  17. package/docs/functions/sleep.html +175 -2
  18. package/docs/functions/snakeToCamel.html +178 -0
  19. package/docs/functions/timeLog.html +175 -2
  20. package/docs/functions/to.html +175 -2
  21. package/docs/functions/withCache.html +177 -4
  22. package/docs/hierarchy.html +174 -1
  23. package/docs/index.html +175 -2
  24. package/docs/modules.html +174 -1
  25. package/docs/types/DeepMapKeys.html +174 -0
  26. package/docs/types/DeepMapValues.html +174 -0
  27. package/docs/types/Primitive.html +174 -0
  28. package/docs/types/RequestInit.html +174 -1
  29. package/docs/types/SetTtl.html +174 -1
  30. package/package.json +6 -2
  31. package/src/dom.ts +10 -10
  32. package/src/hoc.ts +115 -115
  33. package/src/index.ts +1 -0
  34. package/src/is.ts +3 -1
  35. package/src/lru-cache.ts +50 -50
  36. package/src/network.ts +111 -111
  37. package/src/object.ts +113 -0
  38. package/src/string.ts +22 -0
  39. package/src/time.ts +11 -11
  40. package/tsconfig.json +32 -32
@@ -1 +1,174 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SetTtl | @nickyzj2023/utils</title><meta name="description" content="Documentation for @nickyzj2023/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nickyzj2023/utils</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SetTtl</a></li></ul><h1>Type Alias SetTtl</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">SetTtl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Nickyzj628/utils/blob/3ade3c52cfda67786634fc87815788fd69ecfbcc/src/hoc.ts#L6">hoc.ts:6</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nickyzj2023/utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SetTtl | @nickyzj2023/utils</title><meta name="description" content="Documentation for @nickyzj2023/utils"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
2
+ @media (prefers-color-scheme: dark) {
3
+ :root {
4
+ --md-sys-color-primary: #f6be46;
5
+ --md-sys-color-on-primary: #412d00;
6
+ --md-sys-color-primary-container: #5d4200;
7
+ --md-sys-color-on-primary-container: #ffdea3;
8
+ --md-sys-color-secondary: #d9c4a0;
9
+ --md-sys-color-on-secondary: #3b2f15;
10
+ --md-sys-color-secondary-container: #53452a;
11
+ --md-sys-color-on-secondary-container: #f6e0bb;
12
+ --md-sys-color-tertiary: #b2cfa8;
13
+ --md-sys-color-on-tertiary: #1e361a;
14
+ --md-sys-color-tertiary-container: #344d2f;
15
+ --md-sys-color-on-tertiary-container: #cdebc2;
16
+ --md-sys-color-error: #ffb4ab;
17
+ --md-sys-color-on-error: #690005;
18
+ --md-sys-color-error-container: #93000a;
19
+ --md-sys-color-on-error-container: #ffb4ab;
20
+ --md-sys-color-background: #1e1b16;
21
+ --md-sys-color-on-background: #e9e1d9;
22
+ --md-sys-color-surface: #1e1b16;
23
+ --md-sys-color-on-surface: #e9e1d9;
24
+ --md-sys-color-surface-variant: #4e4639;
25
+ --md-sys-color-on-surface-variant: #d1c5b4;
26
+ --md-sys-color-outline: #9a8f80;
27
+ --md-sys-color-outline-variant: #4e4639;
28
+ --md-sys-color-shadow: #000000;
29
+ --md-sys-color-scrim: #000000;
30
+ --md-sys-color-inverse-surface: #e9e1d9;
31
+ --md-sys-color-inverse-on-surface: #34302a;
32
+ --md-sys-color-inverse-primary: #7a5900;
33
+ --md-sys-color-surface-dim: #16130e;
34
+ --md-sys-color-surface-bright: #3d3933;
35
+ --md-sys-color-surface-container-lowest: #110e09;
36
+ --md-sys-color-surface-container-low: #1e1b16;
37
+ --md-sys-color-surface-container: #221f1a;
38
+ --md-sys-color-surface-container-high: #2d2924;
39
+ --md-sys-color-surface-container-highest: #38342e
40
+ }
41
+ }
42
+ :root[data-theme="dark"] {
43
+ --md-sys-color-primary: #f6be46;
44
+ --md-sys-color-on-primary: #412d00;
45
+ --md-sys-color-primary-container: #5d4200;
46
+ --md-sys-color-on-primary-container: #ffdea3;
47
+ --md-sys-color-secondary: #d9c4a0;
48
+ --md-sys-color-on-secondary: #3b2f15;
49
+ --md-sys-color-secondary-container: #53452a;
50
+ --md-sys-color-on-secondary-container: #f6e0bb;
51
+ --md-sys-color-tertiary: #b2cfa8;
52
+ --md-sys-color-on-tertiary: #1e361a;
53
+ --md-sys-color-tertiary-container: #344d2f;
54
+ --md-sys-color-on-tertiary-container: #cdebc2;
55
+ --md-sys-color-error: #ffb4ab;
56
+ --md-sys-color-on-error: #690005;
57
+ --md-sys-color-error-container: #93000a;
58
+ --md-sys-color-on-error-container: #ffb4ab;
59
+ --md-sys-color-background: #1e1b16;
60
+ --md-sys-color-on-background: #e9e1d9;
61
+ --md-sys-color-surface: #1e1b16;
62
+ --md-sys-color-on-surface: #e9e1d9;
63
+ --md-sys-color-surface-variant: #4e4639;
64
+ --md-sys-color-on-surface-variant: #d1c5b4;
65
+ --md-sys-color-outline: #9a8f80;
66
+ --md-sys-color-outline-variant: #4e4639;
67
+ --md-sys-color-shadow: #000000;
68
+ --md-sys-color-scrim: #000000;
69
+ --md-sys-color-inverse-surface: #e9e1d9;
70
+ --md-sys-color-inverse-on-surface: #34302a;
71
+ --md-sys-color-inverse-primary: #7a5900;
72
+ --md-sys-color-surface-dim: #16130e;
73
+ --md-sys-color-surface-bright: #3d3933;
74
+ --md-sys-color-surface-container-lowest: #110e09;
75
+ --md-sys-color-surface-container-low: #1e1b16;
76
+ --md-sys-color-surface-container: #221f1a;
77
+ --md-sys-color-surface-container-high: #2d2924;
78
+ --md-sys-color-surface-container-highest: #38342e
79
+ }
80
+
81
+ @media (prefers-color-scheme: light) {
82
+ :root {
83
+ --md-sys-color-primary: #7a5900;
84
+ --md-sys-color-on-primary: #ffffff;
85
+ --md-sys-color-primary-container: #ffdea3;
86
+ --md-sys-color-on-primary-container: #261900;
87
+ --md-sys-color-secondary: #6c5c3f;
88
+ --md-sys-color-on-secondary: #ffffff;
89
+ --md-sys-color-secondary-container: #f6e0bb;
90
+ --md-sys-color-on-secondary-container: #251a04;
91
+ --md-sys-color-tertiary: #4b6545;
92
+ --md-sys-color-on-tertiary: #ffffff;
93
+ --md-sys-color-tertiary-container: #cdebc2;
94
+ --md-sys-color-on-tertiary-container: #092007;
95
+ --md-sys-color-error: #ba1a1a;
96
+ --md-sys-color-on-error: #ffffff;
97
+ --md-sys-color-error-container: #ffdad6;
98
+ --md-sys-color-on-error-container: #410002;
99
+ --md-sys-color-background: #fffbff;
100
+ --md-sys-color-on-background: #1e1b16;
101
+ --md-sys-color-surface: #fffbff;
102
+ --md-sys-color-on-surface: #1e1b16;
103
+ --md-sys-color-surface-variant: #ede1cf;
104
+ --md-sys-color-on-surface-variant: #4e4639;
105
+ --md-sys-color-outline: #7f7667;
106
+ --md-sys-color-outline-variant: #d1c5b4;
107
+ --md-sys-color-shadow: #000000;
108
+ --md-sys-color-scrim: #000000;
109
+ --md-sys-color-inverse-surface: #34302a;
110
+ --md-sys-color-inverse-on-surface: #f8efe7;
111
+ --md-sys-color-inverse-primary: #f6be46;
112
+ --md-sys-color-surface-dim: #e1d9d0;
113
+ --md-sys-color-surface-bright: #fff8f2;
114
+ --md-sys-color-surface-container-lowest: #ffffff;
115
+ --md-sys-color-surface-container-low: #fbf2e9;
116
+ --md-sys-color-surface-container: #f5ede4;
117
+ --md-sys-color-surface-container-high: #efe7de;
118
+ --md-sys-color-surface-container-highest: #e9e1d9
119
+ }
120
+ }
121
+ :root[data-theme="light"] {
122
+ --md-sys-color-primary: #7a5900;
123
+ --md-sys-color-on-primary: #ffffff;
124
+ --md-sys-color-primary-container: #ffdea3;
125
+ --md-sys-color-on-primary-container: #261900;
126
+ --md-sys-color-secondary: #6c5c3f;
127
+ --md-sys-color-on-secondary: #ffffff;
128
+ --md-sys-color-secondary-container: #f6e0bb;
129
+ --md-sys-color-on-secondary-container: #251a04;
130
+ --md-sys-color-tertiary: #4b6545;
131
+ --md-sys-color-on-tertiary: #ffffff;
132
+ --md-sys-color-tertiary-container: #cdebc2;
133
+ --md-sys-color-on-tertiary-container: #092007;
134
+ --md-sys-color-error: #ba1a1a;
135
+ --md-sys-color-on-error: #ffffff;
136
+ --md-sys-color-error-container: #ffdad6;
137
+ --md-sys-color-on-error-container: #410002;
138
+ --md-sys-color-background: #fffbff;
139
+ --md-sys-color-on-background: #1e1b16;
140
+ --md-sys-color-surface: #fffbff;
141
+ --md-sys-color-on-surface: #1e1b16;
142
+ --md-sys-color-surface-variant: #ede1cf;
143
+ --md-sys-color-on-surface-variant: #4e4639;
144
+ --md-sys-color-outline: #7f7667;
145
+ --md-sys-color-outline-variant: #d1c5b4;
146
+ --md-sys-color-shadow: #000000;
147
+ --md-sys-color-scrim: #000000;
148
+ --md-sys-color-inverse-surface: #34302a;
149
+ --md-sys-color-inverse-on-surface: #f8efe7;
150
+ --md-sys-color-inverse-primary: #f6be46;
151
+ --md-sys-color-surface-dim: #e1d9d0;
152
+ --md-sys-color-surface-bright: #fff8f2;
153
+ --md-sys-color-surface-container-lowest: #ffffff;
154
+ --md-sys-color-surface-container-low: #fbf2e9;
155
+ --md-sys-color-surface-container: #f5ede4;
156
+ --md-sys-color-surface-container-high: #efe7de;
157
+ --md-sys-color-surface-container-highest: #e9e1d9
158
+ }
159
+ </style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nickyzj2023/utils</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">SetTtl</a></li></ul><h1>Type Alias SetTtl</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">SetTtl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">seconds</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Nickyzj628/utils/blob/f408a18bf8828de9cc8d925dac8de5602462d99c/src/hoc.ts#L6">hoc.ts:6</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nickyzj2023/utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
160
+ try {
161
+ const generateLinkElement = document.querySelector(".tsd-generator a");
162
+ const link = document.createElement("a");
163
+ Object.assign(link, {
164
+ href: "https://github.com/dmnsgn/typedoc-material-theme",
165
+ target: "_blank",
166
+ rel: "noreferrer",
167
+ innerText: "typedoc-material-theme."
168
+ });
169
+ generateLinkElement.insertAdjacentElement("afterend", link);
170
+ generateLinkElement.insertAdjacentText("afterend", " with ");
171
+ } catch (error) {
172
+
173
+ }
174
+ </script></body></html>
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@nickyzj2023/utils",
3
- "version": "1.0.16",
3
+ "version": "1.0.18",
4
4
  "type": "module",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "scripts": {
8
- "docs": "typedoc src/index.ts",
8
+ "docs": "typedoc src/index.ts --plugin typedoc-material-theme",
9
9
  "build": "bun build --target=bun --outdir ./dist --minify ./src/index.ts && tsc && bun run docs"
10
10
  },
11
11
  "devDependencies": {
@@ -18,5 +18,9 @@
18
18
  "repository": {
19
19
  "type": "git",
20
20
  "url": "https://github.com/Nickyzj628/utils.git"
21
+ },
22
+ "dependencies": {
23
+ "es-toolkit": "^1.42.0",
24
+ "typedoc-material-theme": "^1.4.1"
21
25
  }
22
26
  }
package/src/dom.ts CHANGED
@@ -1,10 +1,10 @@
1
- /**
2
- * 附带时间的 console.log
3
- * @param args
4
- *
5
- * @example
6
- * timeLog("Hello", "World"); // 14:30:00 Hello World
7
- */
8
- export const timeLog = (...args: any[]) => {
9
- console.log(`${new Date().toLocaleTimeString()}`, ...args);
10
- };
1
+ /**
2
+ * 附带时间的 console.log
3
+ * @param args
4
+ *
5
+ * @example
6
+ * timeLog("Hello", "World"); // 14:30:00 Hello World
7
+ */
8
+ export const timeLog = (...args: any[]) => {
9
+ console.log(`${new Date().toLocaleTimeString()}`, ...args);
10
+ };
package/src/hoc.ts CHANGED
@@ -1,115 +1,115 @@
1
- type CacheEntry = {
2
- value: any;
3
- expiresAt: number; // 时间戳(毫秒)
4
- };
5
-
6
- export type SetTtl = (seconds: number) => void;
7
-
8
- /**
9
- * 创建一个带缓存的高阶函数
10
- *
11
- * @template Args 被包装函数的参数类型数组
12
- * @template Result 被包装函数的返回类型
13
- *
14
- * @param fn 需要被缓存的函数,参数里附带的 setTtl 方法用于根据具体情况改写过期时间
15
- * @param ttlSeconds 以秒为单位的过期时间,-1 表示永不过期,默认 -1,会被回调函数里的 setTtl() 覆盖
16
- *
17
- * @returns 返回包装后的函数,以及缓存相关的额外方法
18
- *
19
- * @example
20
- * // 异步函数示例
21
- * const fetchData = withCache(async function (url: string) {
22
- * const data = await fetch(url).then((res) => res.json());
23
- * this.setTtl(data.expiresIn); // 根据实际情况调整过期时间
24
- * return data;
25
- * });
26
- *
27
- * await fetchData(urlA);
28
- * await fetchData(urlA); // 使用缓存结果
29
- * await fetchData(urlB);
30
- * await fetchData(urlB); // 使用缓存结果
31
- *
32
- * fetchData.clear(); // 清除缓存
33
- * await fetchData(urlA); // 重新请求
34
- * await fetchData(urlB); // 重新请求
35
- *
36
- * // 缓存过期前
37
- * await sleep();
38
- * fetchData.updateTtl(180); // 更新 ttl 并为所有未过期的缓存续期
39
- * await fetchData(urlA); // 使用缓存结果
40
- * await fetchData(urlB); // 使用缓存结果
41
- */
42
- export const withCache = <Args extends any[], Result>(
43
- fn: (this: { setTtl: SetTtl }, ...args: Args) => Result,
44
- ttlSeconds = -1,
45
- ) => {
46
- const cache = new Map<string, CacheEntry>();
47
-
48
- const wrapped = (...args: Args): Result => {
49
- const key = JSON.stringify(args);
50
- const now = Date.now();
51
- const entry = cache.get(key);
52
-
53
- // 命中缓存且未过期
54
- if (entry && now < entry.expiresAt) {
55
- return entry.value;
56
- }
57
-
58
- let expiresAt = ttlSeconds === -1 ? Infinity : now + ttlSeconds * 1000;
59
-
60
- // 创建上下文,包含 setTtl 方法
61
- const thisArg = {
62
- setTtl: (ttl: number) => (expiresAt = now + ttl * 1000),
63
- };
64
-
65
- const result = fn.apply(thisArg, args);
66
-
67
- // 异步函数:缓存 Promise 的 resolved 值
68
- if (result instanceof Promise) {
69
- const promise = result.then((resolved) => {
70
- cache.set(key, {
71
- value: resolved,
72
- expiresAt,
73
- });
74
- return resolved;
75
- });
76
-
77
- // 将 promise 先塞进去避免重复请求
78
- cache.set(key, {
79
- value: promise,
80
- expiresAt,
81
- });
82
-
83
- return promise as Result;
84
- }
85
-
86
- // 同步函数缓存
87
- cache.set(key, {
88
- value: result,
89
- expiresAt,
90
- });
91
-
92
- return result;
93
- };
94
-
95
- /** 手动清除缓存 */
96
- wrapped.clear = () => cache.clear();
97
-
98
- /** 更新 TTL,同时刷新所有未过期缓存的时间 */
99
- wrapped.updateTtl = (seconds: number) => {
100
- // 更新默认 TTL
101
- ttlSeconds = seconds;
102
-
103
- // 给未过期缓存续期
104
- const now = Date.now();
105
- const newExpiresAt = now + seconds * 1000;
106
- for (const [key, entry] of cache.entries()) {
107
- if (entry.expiresAt > now) {
108
- entry.expiresAt = newExpiresAt;
109
- cache.set(key, entry);
110
- }
111
- }
112
- };
113
-
114
- return wrapped;
115
- };
1
+ type CacheEntry = {
2
+ value: any;
3
+ expiresAt: number; // 时间戳(毫秒)
4
+ };
5
+
6
+ export type SetTtl = (seconds: number) => void;
7
+
8
+ /**
9
+ * 创建一个带缓存的高阶函数
10
+ *
11
+ * @template Args 被包装函数的参数类型数组
12
+ * @template Result 被包装函数的返回类型
13
+ *
14
+ * @param fn 需要被缓存的函数,参数里附带的 setTtl 方法用于根据具体情况改写过期时间
15
+ * @param ttlSeconds 以秒为单位的过期时间,-1 表示永不过期,默认 -1,会被回调函数里的 setTtl() 覆盖
16
+ *
17
+ * @returns 返回包装后的函数,以及缓存相关的额外方法
18
+ *
19
+ * @example
20
+ * // 异步函数示例
21
+ * const fetchData = withCache(async function (url: string) {
22
+ * const data = await fetch(url).then((res) => res.json());
23
+ * this.setTtl(data.expiresIn); // 根据实际情况调整过期时间
24
+ * return data;
25
+ * });
26
+ *
27
+ * await fetchData(urlA);
28
+ * await fetchData(urlA); // 使用缓存结果
29
+ * await fetchData(urlB);
30
+ * await fetchData(urlB); // 使用缓存结果
31
+ *
32
+ * fetchData.clear(); // 清除缓存
33
+ * await fetchData(urlA); // 重新请求
34
+ * await fetchData(urlB); // 重新请求
35
+ *
36
+ * // 缓存过期前
37
+ * await sleep();
38
+ * fetchData.updateTtl(180); // 更新 ttl 并为所有未过期的缓存续期
39
+ * await fetchData(urlA); // 使用缓存结果
40
+ * await fetchData(urlB); // 使用缓存结果
41
+ */
42
+ export const withCache = <Args extends any[], Result>(
43
+ fn: (this: { setTtl: SetTtl }, ...args: Args) => Result,
44
+ ttlSeconds = -1,
45
+ ) => {
46
+ const cache = new Map<string, CacheEntry>();
47
+
48
+ const wrapped = (...args: Args): Result => {
49
+ const key = JSON.stringify(args);
50
+ const now = Date.now();
51
+ const entry = cache.get(key);
52
+
53
+ // 命中缓存且未过期
54
+ if (entry && now < entry.expiresAt) {
55
+ return entry.value;
56
+ }
57
+
58
+ let expiresAt = ttlSeconds === -1 ? Infinity : now + ttlSeconds * 1000;
59
+
60
+ // 创建上下文,包含 setTtl 方法
61
+ const thisArg = {
62
+ setTtl: (ttl: number) => (expiresAt = now + ttl * 1000),
63
+ };
64
+
65
+ const result = fn.apply(thisArg, args);
66
+
67
+ // 异步函数:缓存 Promise 的 resolved 值
68
+ if (result instanceof Promise) {
69
+ const promise = result.then((resolved) => {
70
+ cache.set(key, {
71
+ value: resolved,
72
+ expiresAt,
73
+ });
74
+ return resolved;
75
+ });
76
+
77
+ // 将 promise 先塞进去避免重复请求
78
+ cache.set(key, {
79
+ value: promise,
80
+ expiresAt,
81
+ });
82
+
83
+ return promise as Result;
84
+ }
85
+
86
+ // 同步函数缓存
87
+ cache.set(key, {
88
+ value: result,
89
+ expiresAt,
90
+ });
91
+
92
+ return result;
93
+ };
94
+
95
+ /** 手动清除缓存 */
96
+ wrapped.clear = () => cache.clear();
97
+
98
+ /** 更新 TTL,同时刷新所有未过期缓存的时间 */
99
+ wrapped.updateTtl = (seconds: number) => {
100
+ // 更新默认 TTL
101
+ ttlSeconds = seconds;
102
+
103
+ // 给未过期缓存续期
104
+ const now = Date.now();
105
+ const newExpiresAt = now + seconds * 1000;
106
+ for (const [key, entry] of cache.entries()) {
107
+ if (entry.expiresAt > now) {
108
+ entry.expiresAt = newExpiresAt;
109
+ cache.set(key, entry);
110
+ }
111
+ }
112
+ };
113
+
114
+ return wrapped;
115
+ };
package/src/index.ts CHANGED
@@ -3,4 +3,5 @@ export * from "./hoc";
3
3
  export * from "./is";
4
4
  export * from "./network";
5
5
  export * from "./object";
6
+ export * from "./string";
6
7
  export * from "./time";
package/src/is.ts CHANGED
@@ -1,3 +1,5 @@
1
+ export type Primitive = number | string | boolean | symbol | bigint | undefined | null;
2
+
1
3
  /**
2
4
  * 检测传入的值是否为**普通对象**
3
5
  * @returns 如果是普通对象,返回 true,否则返回 false
@@ -10,7 +12,7 @@ export const isObject = (value: any): value is object => {
10
12
  * 检测传入的值是否为**原始值**(number、string、boolean、symbol、bigint、undefined、null)
11
13
  * @returns 如果是原始值,返回 true,否则返回 false
12
14
  */
13
- export const isPrimitive = (value: any) => {
15
+ export const isPrimitive = (value: any): value is Primitive => {
14
16
  return (
15
17
  value === null ||
16
18
  value === undefined ||
package/src/lru-cache.ts CHANGED
@@ -1,50 +1,50 @@
1
- /**
2
- * 简易 LRU 缓存
3
- * @example
4
- * const cache = new LRUCache<string, number>(2);
5
- * cache.set("a", 1);
6
- * cache.set("b", 2);
7
- * cache.set("c", 3); // 缓存已满,a 被淘汰
8
- * cache.get("a"); // undefined
9
- */
10
- class LRUCache<K, V> {
11
- private cache: Map<K, V>;
12
- private maxSize: number;
13
-
14
- constructor(maxSize = 10) {
15
- this.cache = new Map();
16
- this.maxSize = maxSize;
17
- }
18
-
19
- get(key: K): V | undefined {
20
- const value = this.cache.get(key);
21
- if (!value) {
22
- return undefined;
23
- }
24
- // 重置缓存顺序
25
- this.cache.delete(key);
26
- this.cache.set(key, value);
27
- return value;
28
- }
29
-
30
- set(key: K, value: V) {
31
- // 刷新缓存
32
- if (this.cache.has(key)) {
33
- this.cache.delete(key);
34
- }
35
- // 删除最旧的缓存
36
- else if (this.cache.size >= this.maxSize) {
37
- const oldestKey = [...this.cache.keys()][0];
38
- if (oldestKey) {
39
- this.cache.delete(oldestKey);
40
- }
41
- }
42
- this.cache.set(key, value);
43
- }
44
-
45
- has(key: K) {
46
- return this.cache.has(key);
47
- }
48
- }
49
-
50
- export default LRUCache;
1
+ /**
2
+ * 简易 LRU 缓存
3
+ * @example
4
+ * const cache = new LRUCache<string, number>(2);
5
+ * cache.set("a", 1);
6
+ * cache.set("b", 2);
7
+ * cache.set("c", 3); // 缓存已满,a 被淘汰
8
+ * cache.get("a"); // undefined
9
+ */
10
+ class LRUCache<K, V> {
11
+ private cache: Map<K, V>;
12
+ private maxSize: number;
13
+
14
+ constructor(maxSize = 10) {
15
+ this.cache = new Map();
16
+ this.maxSize = maxSize;
17
+ }
18
+
19
+ get(key: K): V | undefined {
20
+ const value = this.cache.get(key);
21
+ if (!value) {
22
+ return undefined;
23
+ }
24
+ // 重置缓存顺序
25
+ this.cache.delete(key);
26
+ this.cache.set(key, value);
27
+ return value;
28
+ }
29
+
30
+ set(key: K, value: V) {
31
+ // 刷新缓存
32
+ if (this.cache.has(key)) {
33
+ this.cache.delete(key);
34
+ }
35
+ // 删除最旧的缓存
36
+ else if (this.cache.size >= this.maxSize) {
37
+ const oldestKey = [...this.cache.keys()][0];
38
+ if (oldestKey) {
39
+ this.cache.delete(oldestKey);
40
+ }
41
+ }
42
+ this.cache.set(key, value);
43
+ }
44
+
45
+ has(key: K) {
46
+ return this.cache.has(key);
47
+ }
48
+ }
49
+
50
+ export default LRUCache;