@secrecy/lib 1.0.0-dev.25 → 1.0.0-dev.28

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 (155) hide show
  1. package/dist/BaseClient.d.ts +274 -0
  2. package/dist/BaseClient.js +2227 -0
  3. package/dist/PopupTools.d.ts +17 -0
  4. package/dist/PopupTools.js +213 -0
  5. package/dist/ZeusThunder.d.ts +2 -0
  6. package/dist/ZeusThunder.js +113 -0
  7. package/dist/cache.d.ts +7 -0
  8. package/dist/cache.js +5 -0
  9. package/dist/client/admin/index.d.ts +11 -0
  10. package/dist/client/admin/index.js +198 -0
  11. package/dist/client/convert/file.d.ts +5 -0
  12. package/dist/client/convert/file.js +39 -0
  13. package/dist/client/convert/folder.d.ts +8 -0
  14. package/dist/client/convert/folder.js +264 -0
  15. package/dist/client/convert/mail.d.ts +3 -0
  16. package/dist/client/convert/mail.js +46 -0
  17. package/dist/client/convert/vFile.d.ts +5 -0
  18. package/dist/client/convert/vFile.js +164 -0
  19. package/dist/client/helpers.d.ts +23 -0
  20. package/dist/client/helpers.js +114 -0
  21. package/dist/client/index.d.ts +172 -0
  22. package/dist/client/index.js +6169 -0
  23. package/dist/client/storage.d.ts +7 -0
  24. package/dist/client/storage.js +12 -0
  25. package/dist/client/types/File.d.ts +21 -0
  26. package/dist/client/types/File.js +3 -0
  27. package/dist/client/types/FilesOnUsersOnApplications.d.ts +9 -0
  28. package/dist/client/types/FilesOnUsersOnApplications.js +3 -0
  29. package/dist/client/types/Folder.d.ts +68 -0
  30. package/dist/client/types/Folder.js +7 -0
  31. package/dist/client/types/Inputs.d.ts +21 -0
  32. package/dist/client/types/Inputs.js +3 -0
  33. package/dist/client/types/UserAppNotifications.d.ts +6 -0
  34. package/dist/client/types/UserAppNotifications.js +3 -0
  35. package/dist/client/types/UserAppSettings.d.ts +7 -0
  36. package/dist/client/types/UserAppSettings.js +3 -0
  37. package/dist/client/types/VFile.d.ts +62 -0
  38. package/dist/client/types/VFile.js +4 -0
  39. package/dist/client/types/index.d.ts +154 -0
  40. package/dist/client/types/index.js +10 -0
  41. package/dist/client/types/queries.d.ts +535 -0
  42. package/dist/client/types/queries.js +192 -0
  43. package/dist/crypto/file.d.ts +14 -0
  44. package/dist/crypto/file.js +291 -0
  45. package/dist/crypto/index.d.ts +12 -0
  46. package/dist/crypto/index.js +45 -0
  47. package/dist/error.d.ts +30 -0
  48. package/dist/error.js +3 -0
  49. package/dist/index.d.ts +13 -3857
  50. package/dist/index.js +42 -255
  51. package/dist/minify/index.d.ts +2 -0
  52. package/dist/minify/index.js +28 -0
  53. package/dist/minify/lz4.d.ts +5 -0
  54. package/dist/minify/lz4.js +633 -0
  55. package/dist/sodium.d.ts +3 -0
  56. package/dist/sodium.js +28 -0
  57. package/dist/utils/store-buddy.d.ts +14 -0
  58. package/dist/utils/store-buddy.js +69 -0
  59. package/dist/utils/time.d.ts +10 -0
  60. package/dist/utils/time.js +22 -0
  61. package/dist/utils.d.ts +4 -0
  62. package/dist/utils.js +188 -0
  63. package/dist/worker/__mock__/sodium.worker.d.ts +19 -0
  64. package/dist/worker/__mock__/sodium.worker.js +46 -0
  65. package/dist/worker/md5.d.ts +1 -0
  66. package/dist/worker/md5.js +43 -0
  67. package/dist/worker/sodium.d.ts +3 -0
  68. package/dist/worker/sodium.js +155 -0
  69. package/dist/worker/workerCodes.d.ts +2 -0
  70. package/dist/worker/workerCodes.js +3 -0
  71. package/dist/zeus/const.d.ts +2 -0
  72. package/dist/zeus/const.js +2267 -0
  73. package/dist/zeus/index.d.ts +4043 -0
  74. package/dist/zeus/index.js +549 -0
  75. package/package.json +24 -16
  76. package/CHANGELOG.md +0 -178
  77. package/__tests__/client/client.test.ts +0 -81
  78. package/__tests__/client/folder.test.ts +0 -302
  79. package/__tests__/client/mail.test.ts +0 -476
  80. package/__tests__/client/timing.test.ts +0 -35
  81. package/__tests__/client/utils.ts +0 -41
  82. package/__tests__/client/vFile.test.ts +0 -207
  83. package/__tests__/index.test.ts +0 -171
  84. package/commitlint.config.cjs +0 -3
  85. package/dist/index.js.map +0 -1
  86. package/dist/index.mjs +0 -255
  87. package/dist/index.mjs.map +0 -1
  88. package/docs/assets/css/main.css +0 -2660
  89. package/docs/assets/images/icons.png +0 -0
  90. package/docs/assets/images/icons@2x.png +0 -0
  91. package/docs/assets/images/widgets.png +0 -0
  92. package/docs/assets/images/widgets@2x.png +0 -0
  93. package/docs/assets/js/main.js +0 -248
  94. package/docs/assets/js/search.js +0 -1
  95. package/docs/classes/baseclient.baseclient-1.html +0 -1165
  96. package/docs/classes/client.secrecyclient.html +0 -2527
  97. package/docs/enums/index.sodium.base64_variants.html +0 -205
  98. package/docs/index.html +0 -198
  99. package/docs/interfaces/client_types.draftmail.html +0 -335
  100. package/docs/interfaces/client_types.filecontentbase.html +0 -231
  101. package/docs/interfaces/client_types.filecontentcloud.html +0 -244
  102. package/docs/interfaces/client_types.filecontentreceivedmail.html +0 -244
  103. package/docs/interfaces/client_types.filecontentsentmail.html +0 -230
  104. package/docs/interfaces/client_types.receivedmail.html +0 -363
  105. package/docs/interfaces/client_types.sentmail.html +0 -335
  106. package/docs/interfaces/crypto.keypair.html +0 -202
  107. package/docs/interfaces/index.sodium.cryptobox.html +0 -185
  108. package/docs/interfaces/index.sodium.cryptokx.html +0 -185
  109. package/docs/interfaces/index.sodium.keypair.html +0 -199
  110. package/docs/interfaces/index.sodium.messagetag.html +0 -185
  111. package/docs/interfaces/index.sodium.secretbox.html +0 -185
  112. package/docs/interfaces/index.sodium.stateaddress.html +0 -171
  113. package/docs/interfaces/index.sodium.stringcryptobox.html +0 -185
  114. package/docs/interfaces/index.sodium.stringcryptokx.html +0 -185
  115. package/docs/interfaces/index.sodium.stringkeypair.html +0 -199
  116. package/docs/interfaces/index.sodium.stringmessagetag.html +0 -185
  117. package/docs/interfaces/index.sodium.stringsecretbox.html +0 -185
  118. package/docs/interfaces/utils_store_buddy.storebuddy.html +0 -333
  119. package/docs/modules/baseclient.html +0 -929
  120. package/docs/modules/cache.html +0 -185
  121. package/docs/modules/client.html +0 -207
  122. package/docs/modules/client_convert_file.html +0 -216
  123. package/docs/modules/client_convert_folder.html +0 -303
  124. package/docs/modules/client_convert_vfile.html +0 -216
  125. package/docs/modules/client_helpers.html +0 -311
  126. package/docs/modules/client_storage.html +0 -167
  127. package/docs/modules/client_types.html +0 -1227
  128. package/docs/modules/client_types_file.html +0 -233
  129. package/docs/modules/client_types_filesonusersonapplications.html +0 -168
  130. package/docs/modules/client_types_folder.html +0 -383
  131. package/docs/modules/client_types_inputs.html +0 -263
  132. package/docs/modules/client_types_mail.html +0 -181
  133. package/docs/modules/client_types_queries.html +0 -199
  134. package/docs/modules/client_types_userappsettings.html +0 -163
  135. package/docs/modules/client_types_vfile.html +0 -364
  136. package/docs/modules/crypto.html +0 -366
  137. package/docs/modules/crypto_file.html +0 -344
  138. package/docs/modules/index.html +0 -779
  139. package/docs/modules/index.sodium.html +0 -6039
  140. package/docs/modules/minify.html +0 -183
  141. package/docs/modules/minify_lz4.html +0 -279
  142. package/docs/modules/popuptools.html +0 -259
  143. package/docs/modules/sodium.html +0 -167
  144. package/docs/modules/utils.html +0 -219
  145. package/docs/modules/utils_store_buddy.html +0 -208
  146. package/docs/modules/utils_time.html +0 -330
  147. package/docs/modules/worker_md5.html +0 -156
  148. package/docs/modules/worker_sodium.html +0 -231
  149. package/docs/modules/worker_workercodes.html +0 -157
  150. package/docs/modules.html +0 -235
  151. package/index.html +0 -21
  152. package/jest.config.ts +0 -27
  153. package/jest.setup.ts +0 -6
  154. package/release.config.cjs +0 -15
  155. package/tsup.config.ts +0 -23
package/docs/interfaces/utils_store_buddy.storebuddy.html DELETED
@@ -1,333 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>StoreBuddy | @secrecy/lib</title>
7
- <meta name="description" content="Documentation for @secrecy/lib">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@secrecy/lib</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@secrecy/lib</a>
56
- </li>
57
- <li>
58
- <a href="../modules/utils_store_buddy.html">utils/store-buddy</a>
59
- </li>
60
- <li>
61
- <a href="utils_store_buddy.StoreBuddy.html">StoreBuddy</a>
62
- </li>
63
- </ul>
64
- <h1>Interface StoreBuddy&lt;T&gt;</h1>
65
- </div>
66
- </div>
67
- </header>
68
- <div class="container container-main">
69
- <div class="row">
70
- <div class="col-8 col-content">
71
- <section class="tsd-panel tsd-type-parameters">
72
- <h3>Type parameters</h3>
73
- <ul class="tsd-type-parameters">
74
- <li>
75
- <h4>T</h4>
76
- </li>
77
- </ul>
78
- </section>
79
- <section class="tsd-panel tsd-hierarchy">
80
- <h3>Hierarchy</h3>
81
- <ul class="tsd-hierarchy">
82
- <li>
83
- <span class="target">StoreBuddy</span>
84
- </li>
85
- </ul>
86
- </section>
87
- <section class="tsd-panel-group tsd-index-group">
88
- <h2>Index</h2>
89
- <section class="tsd-panel tsd-index-panel">
90
- <div class="tsd-index-content">
91
- <section class="tsd-index-section ">
92
- <h3>Methods</h3>
93
- <ul class="tsd-index-list">
94
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="utils_store_buddy.StoreBuddy.html#clear" class="tsd-kind-icon">clear</a></li>
95
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="utils_store_buddy.StoreBuddy.html#load" class="tsd-kind-icon">load</a></li>
96
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="utils_store_buddy.StoreBuddy.html#reset" class="tsd-kind-icon">reset</a></li>
97
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="utils_store_buddy.StoreBuddy.html#save" class="tsd-kind-icon">save</a></li>
98
- </ul>
99
- </section>
100
- </div>
101
- </section>
102
- </section>
103
- <section class="tsd-panel-group tsd-member-group ">
104
- <h2>Methods</h2>
105
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
106
- <a name="clear" class="tsd-anchor"></a>
107
- <h3>clear</h3>
108
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
109
- <li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
110
- </ul>
111
- <ul class="tsd-descriptions">
112
- <li class="tsd-description">
113
- <aside class="tsd-sources">
114
- <ul>
115
- <li>Defined in src/utils/store-buddy.ts:103</li>
116
- </ul>
117
- </aside>
118
- <div class="tsd-comment tsd-typography">
119
- <div class="lead">
120
- <p>Remove all data set using this instance.</p>
121
- </div>
122
- <dl class="tsd-comment-tags">
123
- <dt>example</dt>
124
- <dd><pre><code class="language-ts"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">storeBuddy</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;store-buddy&quot;</span><span style="color: #000000">;</span>
125
-
126
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage</span><span style="color: #000000"> = </span><span style="color: #795E26">storeBuddy</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;foo&quot;</span><span style="color: #000000">).</span><span style="color: #795E26">init</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;bar&quot;</span><span style="color: #000000">);</span>
127
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">load</span><span style="color: #000000">(); </span><span style="color: #008000">// returns &quot;bar&quot;</span>
128
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">clear</span><span style="color: #000000">();</span>
129
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">load</span><span style="color: #000000">(); </span><span style="color: #008000">// throws an error (no data exists)</span>
130
- </code></pre>
131
- </dd>
132
- </dl>
133
- </div>
134
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
135
- </li>
136
- </ul>
137
- </section>
138
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
139
- <a name="load" class="tsd-anchor"></a>
140
- <h3>load</h3>
141
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
142
- <li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IsEmptyObject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
143
- </ul>
144
- <ul class="tsd-descriptions">
145
- <li class="tsd-description">
146
- <aside class="tsd-sources">
147
- <ul>
148
- <li>Defined in src/utils/store-buddy.ts:42</li>
149
- </ul>
150
- </aside>
151
- <div class="tsd-comment tsd-typography">
152
- <div class="lead">
153
- <p>Retrieve the current data set using this instance.</p>
154
- </div>
155
- <dl class="tsd-comment-tags">
156
- <dt>example</dt>
157
- <dd><pre><code class="language-ts"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">storeBuddy</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;store-buddy&quot;</span><span style="color: #000000">;</span>
158
-
159
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage1</span><span style="color: #000000"> = </span><span style="color: #795E26">storeBuddy</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;foo&quot;</span><span style="color: #000000">).</span><span style="color: #795E26">init</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;bar&quot;</span><span style="color: #000000">);</span>
160
- <span style="color: #001080">storage1</span><span style="color: #000000">.</span><span style="color: #795E26">load</span><span style="color: #000000">(); </span><span style="color: #008000">// returns &quot;bar&quot;</span>
161
- </code></pre>
162
- </dd>
163
- </dl>
164
- </div>
165
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IsEmptyObject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
166
- <p>The data from localStorage or sessionStorage, throwing an error
167
- if no data is found.</p>
168
- </li>
169
- </ul>
170
- </section>
171
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
172
- <a name="reset" class="tsd-anchor"></a>
173
- <h3>reset</h3>
174
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
175
- <li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
176
- </ul>
177
- <ul class="tsd-descriptions">
178
- <li class="tsd-description">
179
- <aside class="tsd-sources">
180
- <ul>
181
- <li>Defined in src/utils/store-buddy.ts:88</li>
182
- </ul>
183
- </aside>
184
- <div class="tsd-comment tsd-typography">
185
- <div class="lead">
186
- <p>Reset the data back to its original value set with the <code>init</code> method.</p>
187
- </div>
188
- <dl class="tsd-comment-tags">
189
- <dt>example</dt>
190
- <dd><pre><code class="language-ts"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">storeBuddy</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;store-buddy&quot;</span><span style="color: #000000">;</span>
191
-
192
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage</span><span style="color: #000000"> = </span><span style="color: #795E26">storeBuddy</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;foo&quot;</span><span style="color: #000000">).</span><span style="color: #795E26">init</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;bar&quot;</span><span style="color: #000000">);</span>
193
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">save</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;hello&quot;</span><span style="color: #000000">);</span>
194
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">reset</span><span style="color: #000000">();</span>
195
- <span style="color: #001080">storage</span><span style="color: #000000">.</span><span style="color: #795E26">load</span><span style="color: #000000">(); </span><span style="color: #008000">// returns &quot;bar&quot;</span>
196
- </code></pre>
197
- </dd>
198
- </dl>
199
- </div>
200
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
201
- </li>
202
- </ul>
203
- </section>
204
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
205
- <a name="save" class="tsd-anchor"></a>
206
- <h3>save</h3>
207
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
208
- <li class="tsd-signature tsd-kind-icon">save<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IsEmptyObject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
209
- </ul>
210
- <ul class="tsd-descriptions">
211
- <li class="tsd-description">
212
- <aside class="tsd-sources">
213
- <ul>
214
- <li>Defined in src/utils/store-buddy.ts:73</li>
215
- </ul>
216
- </aside>
217
- <div class="tsd-comment tsd-typography">
218
- <div class="lead">
219
- <p>Set new data or overwrite old data in localStorage or sessionStorage. For
220
- TS developers, saving data of a <em>different</em> type to the one specified in
221
- the type parameter is prevented.</p>
222
- </div>
223
- <dl class="tsd-comment-tags">
224
- <dt>example</dt>
225
- <dd><pre><code class="language-ts"><span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #001080">storeBuddy</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;store-buddy&quot;</span><span style="color: #000000">;</span>
226
-
227
- <span style="color: #008000">// Saves the string &quot;bar&quot; to the localStorage entry with the key &quot;foo&quot;</span>
228
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage1</span><span style="color: #000000"> = </span><span style="color: #795E26">storeBuddy</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;foo&quot;</span><span style="color: #000000">).</span><span style="color: #795E26">init</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;bar&quot;</span><span style="color: #000000">);</span>
229
-
230
- <span style="color: #008000">// Overwrites that same string with different data. Note that, without</span>
231
- <span style="color: #008000">// specifying a specific type when initialising, there is no type safety</span>
232
- <span style="color: #008000">// provided for TypeScript developers</span>
233
- <span style="color: #001080">storage1</span><span style="color: #000000">.</span><span style="color: #795E26">save</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;baz&quot;</span><span style="color: #000000">);</span>
234
- <span style="color: #001080">storage1</span><span style="color: #000000">.</span><span style="color: #795E26">save</span><span style="color: #000000">(</span><span style="color: #098658">123</span><span style="color: #000000">);</span>
235
-
236
- <span style="color: #008000">// This is type-safe...</span>
237
- <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">storage2</span><span style="color: #000000"> = </span><span style="color: #795E26">storeBuddy</span><span style="color: #000000">&lt;</span><span style="color: #267F99">number</span><span style="color: #000000">&gt;(</span><span style="color: #A31515">&quot;foo&quot;</span><span style="color: #000000">).</span><span style="color: #795E26">init</span><span style="color: #000000">(</span><span style="color: #098658">123</span><span style="color: #000000">);</span>
238
-
239
- <span style="color: #008000">// ...so this works...</span>
240
- <span style="color: #001080">storage2</span><span style="color: #000000">.</span><span style="color: #795E26">save</span><span style="color: #000000">(</span><span style="color: #098658">456</span><span style="color: #000000">);</span>
241
-
242
- <span style="color: #008000">// ...and this does not work :)</span>
243
- <span style="color: #001080">storage2</span><span style="color: #000000">.</span><span style="color: #795E26">save</span><span style="color: #000000">(</span><span style="color: #A31515">&quot;I am not a number&quot;</span><span style="color: #000000">);</span>
244
- </code></pre>
245
- </dd>
246
- </dl>
247
- </div>
248
- <h4 class="tsd-parameters-title">Parameters</h4>
249
- <ul class="tsd-parameters">
250
- <li>
251
- <h5>data: <span class="tsd-signature-type">IsEmptyObject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
252
- <div class="tsd-comment tsd-typography">
253
- <p>The data to save to localStorage or sessionStorage.</p>
254
- </div>
255
- </li>
256
- </ul>
257
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
258
- </li>
259
- </ul>
260
- </section>
261
- </section>
262
- </div>
263
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
264
- <nav class="tsd-navigation primary">
265
- <ul>
266
- <li class=" ">
267
- <a href="../modules.html">Modules</a>
268
- </li>
269
- <li class="current tsd-kind-module">
270
- <a href="../modules/utils_store_buddy.html">utils/store-<wbr>buddy</a>
271
- </li>
272
- </ul>
273
- </nav>
274
- <nav class="tsd-navigation secondary menu-sticky">
275
- <ul class="before-current">
276
- </ul>
277
- <ul class="current">
278
- <li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
279
- <a href="utils_store_buddy.StoreBuddy.html" class="tsd-kind-icon">Store<wbr>Buddy</a>
280
- <ul>
281
- <li class=" tsd-kind-method tsd-parent-kind-interface">
282
- <a href="utils_store_buddy.StoreBuddy.html#clear" class="tsd-kind-icon">clear</a>
283
- </li>
284
- <li class=" tsd-kind-method tsd-parent-kind-interface">
285
- <a href="utils_store_buddy.StoreBuddy.html#load" class="tsd-kind-icon">load</a>
286
- </li>
287
- <li class=" tsd-kind-method tsd-parent-kind-interface">
288
- <a href="utils_store_buddy.StoreBuddy.html#reset" class="tsd-kind-icon">reset</a>
289
- </li>
290
- <li class=" tsd-kind-method tsd-parent-kind-interface">
291
- <a href="utils_store_buddy.StoreBuddy.html#save" class="tsd-kind-icon">save</a>
292
- </li>
293
- </ul>
294
- </li>
295
- </ul>
296
- <ul class="after-current">
297
- <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
298
- <a href="../modules/utils_store_buddy.html#storeBuddy" class="tsd-kind-icon">store<wbr>Buddy</a>
299
- </li>
300
- </ul>
301
- </nav>
302
- </div>
303
- </div>
304
- </div>
305
- <footer class="with-border-bottom">
306
- <div class="container">
307
- <h2>Legend</h2>
308
- <div class="tsd-legend-group">
309
- <ul class="tsd-legend">
310
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
311
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
312
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
313
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
314
- <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
315
- </ul>
316
- <ul class="tsd-legend">
317
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
318
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
319
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
320
- </ul>
321
- <ul class="tsd-legend">
322
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
323
- </ul>
324
- </div>
325
- </div>
326
- </footer>
327
- <div class="container tsd-generator">
328
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
329
- </div>
330
- <div class="overlay"></div>
331
- <script src="../assets/js/main.js"></script>
332
- </body>
333
- </html>