@xylabs/forget 2.9.0 → 2.9.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 (14) hide show
  1. package/dist/cjs/forget.js +1 -1
  2. package/dist/cjs/forget.js.map +1 -1
  3. package/dist/docs.json +181 -41
  4. package/dist/esm/forget.js +1 -2
  5. package/dist/esm/forget.js.map +1 -1
  6. package/docs/assets/highlight.css +50 -0
  7. package/docs/assets/main.js +58 -0
  8. package/docs/assets/search.js +1 -0
  9. package/docs/assets/style.css +1367 -0
  10. package/docs/classes/ForgetPromise.html +134 -0
  11. package/docs/functions/forget.html +54 -0
  12. package/docs/index.html +84 -0
  13. package/docs/modules.html +63 -0
  14. package/package.json +4 -4
package/dist/cjs/forget.js CHANGED
@@ -60,8 +60,8 @@ class ForgetPromise {
60
60
  });
61
61
  }
62
62
  }
63
- ForgetPromise.activeForgets = 0;
64
63
  exports.ForgetPromise = ForgetPromise;
64
+ ForgetPromise.activeForgets = 0;
65
65
  //used to explicitly launch an async function (or Promise) with awaiting it
66
66
  const forget = (promise, timeout) => {
67
67
  ForgetPromise.forget(promise, timeout);
package/dist/cjs/forget.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"forget.js","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":";;;;AAAA,yCAAqC;AAOrC,MAAa,aAAa;IAGxB,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,CAAO,aAAa,CAAC,QAAQ,GAAG,GAAG,EAAE,OAAgB;;YACzD,IAAI,gBAAgB,GAAG,OAAO,CAAA;YAC9B,OAAO,IAAI,CAAC,MAAM,EAAE;gBAClB,MAAM,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAA;gBACrB,IAAI,gBAAgB,KAAK,SAAS,EAAE;oBAClC,gBAAgB,IAAI,QAAQ,CAAA;oBAC5B,IAAI,gBAAgB,IAAI,CAAC,EAAE;wBACzB,OAAO,IAAI,CAAC,aAAa,CAAA;qBAC1B;iBACF;aACF;YACD,OAAO,CAAC,CAAA;QACV,CAAC;KAAA;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,OAAyB,EAAE,OAA6B;QACpE,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpB,MAAM,cAAc,GAAG,GAAS,EAAE;YAChC,MAAM,OAAO;iBACV,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC,CAAA;QACN,CAAC,CAAA,CAAA;QAED,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,CAAC,CAAA;QAEnC,2CAA2C;QAC3C,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAG,GAAS,EAAE;;gBAC7B,MAAM,IAAA,aAAK,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC1B,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,OAAO,CAAC,KAAK,iBAAiB,CAAC,CAAA;oBAC/E,MAAA,OAAO,CAAC,MAAM,uDAAI,CAAA;iBACnB;YACH,CAAC,CAAA,CAAA;YACD,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC7B;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAElC,GAAG;aACA,IAAI,CAAC,GAAG,EAAE;YACT,OAAM;QACR,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,OAAM;QACR,CAAC,CAAC,CAAA;IACN,CAAC;;AA5DM,2BAAa,GAAG,CAAC,CAAA;AADb,sCAAa;AAgE1B,2EAA2E;AACpE,MAAM,MAAM,GAAG,CAAC,OAAyB,EAAE,OAA6B,EAAE,EAAE;IACjF,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC,CAAA;AAFY,QAAA,MAAM,UAElB"}
1
+ {"version":3,"file":"forget.js","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":";;;;AAAA,yCAAqC;AAOrC,MAAa,aAAa;IAGxB,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,CAAO,aAAa,CAAC,QAAQ,GAAG,GAAG,EAAE,OAAgB;;YACzD,IAAI,gBAAgB,GAAG,OAAO,CAAA;YAC9B,OAAO,IAAI,CAAC,MAAM,EAAE;gBAClB,MAAM,IAAA,aAAK,EAAC,QAAQ,CAAC,CAAA;gBACrB,IAAI,gBAAgB,KAAK,SAAS,EAAE;oBAClC,gBAAgB,IAAI,QAAQ,CAAA;oBAC5B,IAAI,gBAAgB,IAAI,CAAC,EAAE;wBACzB,OAAO,IAAI,CAAC,aAAa,CAAA;qBAC1B;iBACF;aACF;YACD,OAAO,CAAC,CAAA;QACV,CAAC;KAAA;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,OAAyB,EAAE,OAA6B;QACpE,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpB,MAAM,cAAc,GAAG,GAAS,EAAE;YAChC,MAAM,OAAO;iBACV,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC,CAAA;QACN,CAAC,CAAA,CAAA;QAED,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,CAAC,CAAA;QAEnC,2CAA2C;QAC3C,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAG,GAAS,EAAE;;gBAC7B,MAAM,IAAA,aAAK,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC1B,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,OAAO,CAAC,KAAK,iBAAiB,CAAC,CAAA;oBAC/E,MAAA,OAAO,CAAC,MAAM,uDAAI,CAAA;iBACnB;YACH,CAAC,CAAA,CAAA;YACD,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC7B;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAElC,GAAG;aACA,IAAI,CAAC,GAAG,EAAE;YACT,OAAM;QACR,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,OAAM;QACR,CAAC,CAAC,CAAA;IACN,CAAC;;AA7DH,sCA8DC;AA7DQ,2BAAa,GAAG,CAAC,CAAA;AA+D1B,2EAA2E;AACpE,MAAM,MAAM,GAAG,CAAC,OAAyB,EAAE,OAA6B,EAAE,EAAE;IACjF,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC,CAAA;AAFY,QAAA,MAAM,UAElB"}
package/dist/docs.json CHANGED
@@ -1,23 +1,22 @@
1
1
  {
2
2
  "id": 0,
3
3
  "name": "@xylabs/forget",
4
+ "variant": "project",
4
5
  "kind": 1,
5
- "kindString": "Project",
6
6
  "flags": {},
7
- "originalName": "",
8
7
  "children": [
9
8
  {
10
9
  "id": 19,
11
10
  "name": "default",
11
+ "variant": "reference",
12
12
  "kind": 8388608,
13
- "kindString": "Reference",
14
13
  "flags": {},
15
14
  "sources": [
16
15
  {
17
16
  "fileName": "index.ts",
18
17
  "line": 6,
19
18
  "character": 0,
20
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/index.ts#L6"
19
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/index.ts#L6"
21
20
  }
22
21
  ],
23
22
  "target": 1
@@ -25,27 +24,28 @@
25
24
  {
26
25
  "id": 5,
27
26
  "name": "ForgetPromise",
27
+ "variant": "declaration",
28
28
  "kind": 128,
29
- "kindString": "Class",
30
29
  "flags": {},
31
30
  "children": [
32
31
  {
33
32
  "id": 17,
34
33
  "name": "constructor",
34
+ "variant": "declaration",
35
35
  "kind": 512,
36
- "kindString": "Constructor",
37
36
  "flags": {},
38
37
  "signatures": [
39
38
  {
40
39
  "id": 18,
41
40
  "name": "new ForgetPromise",
41
+ "variant": "signature",
42
42
  "kind": 16384,
43
- "kindString": "Constructor signature",
44
43
  "flags": {},
45
44
  "type": {
46
45
  "type": "reference",
47
- "id": 5,
48
- "name": "ForgetPromise"
46
+ "target": 5,
47
+ "name": "ForgetPromise",
48
+ "package": "@xylabs/forget"
49
49
  }
50
50
  }
51
51
  ]
@@ -53,8 +53,8 @@
53
53
  {
54
54
  "id": 6,
55
55
  "name": "activeForgets",
56
+ "variant": "declaration",
56
57
  "kind": 1024,
57
- "kindString": "Property",
58
58
  "flags": {
59
59
  "isStatic": true
60
60
  },
@@ -63,7 +63,7 @@
63
63
  "fileName": "forget.ts",
64
64
  "line": 9,
65
65
  "character": 9,
66
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L9"
66
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L9"
67
67
  }
68
68
  ],
69
69
  "type": {
@@ -75,8 +75,8 @@
75
75
  {
76
76
  "id": 7,
77
77
  "name": "active",
78
+ "variant": "declaration",
78
79
  "kind": 262144,
79
- "kindString": "Accessor",
80
80
  "flags": {
81
81
  "isStatic": true
82
82
  },
@@ -85,15 +85,23 @@
85
85
  "fileName": "forget.ts",
86
86
  "line": 11,
87
87
  "character": 13,
88
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L11"
88
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L11"
89
89
  }
90
90
  ],
91
91
  "getSignature": {
92
92
  "id": 8,
93
93
  "name": "active",
94
+ "variant": "signature",
94
95
  "kind": 524288,
95
- "kindString": "Get signature",
96
96
  "flags": {},
97
+ "sources": [
98
+ {
99
+ "fileName": "forget.ts",
100
+ "line": 11,
101
+ "character": 2,
102
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L11"
103
+ }
104
+ ],
97
105
  "type": {
98
106
  "type": "intrinsic",
99
107
  "name": "boolean"
@@ -103,8 +111,8 @@
103
111
  {
104
112
  "id": 9,
105
113
  "name": "awaitInactive",
114
+ "variant": "declaration",
106
115
  "kind": 2048,
107
- "kindString": "Method",
108
116
  "flags": {
109
117
  "isStatic": true
110
118
  },
@@ -113,22 +121,30 @@
113
121
  "fileName": "forget.ts",
114
122
  "line": 15,
115
123
  "character": 15,
116
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L15"
124
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L15"
117
125
  }
118
126
  ],
119
127
  "signatures": [
120
128
  {
121
129
  "id": 10,
122
130
  "name": "awaitInactive",
131
+ "variant": "signature",
123
132
  "kind": 4096,
124
- "kindString": "Call signature",
125
133
  "flags": {},
134
+ "sources": [
135
+ {
136
+ "fileName": "forget.ts",
137
+ "line": 15,
138
+ "character": 2,
139
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L15"
140
+ }
141
+ ],
126
142
  "parameters": [
127
143
  {
128
144
  "id": 11,
129
145
  "name": "interval",
146
+ "variant": "param",
130
147
  "kind": 32768,
131
- "kindString": "Parameter",
132
148
  "flags": {},
133
149
  "type": {
134
150
  "type": "intrinsic",
@@ -139,8 +155,8 @@
139
155
  {
140
156
  "id": 12,
141
157
  "name": "timeout",
158
+ "variant": "param",
142
159
  "kind": 32768,
143
- "kindString": "Parameter",
144
160
  "flags": {
145
161
  "isOptional": true
146
162
  },
@@ -152,6 +168,10 @@
152
168
  ],
153
169
  "type": {
154
170
  "type": "reference",
171
+ "target": {
172
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
173
+ "qualifiedName": "Promise"
174
+ },
155
175
  "typeArguments": [
156
176
  {
157
177
  "type": "intrinsic",
@@ -159,7 +179,6 @@
159
179
  }
160
180
  ],
161
181
  "name": "Promise",
162
- "qualifiedName": "Promise",
163
182
  "package": "typescript"
164
183
  }
165
184
  }
@@ -168,8 +187,8 @@
168
187
  {
169
188
  "id": 13,
170
189
  "name": "forget",
190
+ "variant": "declaration",
171
191
  "kind": 2048,
172
- "kindString": "Method",
173
192
  "flags": {
174
193
  "isStatic": true
175
194
  },
@@ -178,25 +197,37 @@
178
197
  "fileName": "forget.ts",
179
198
  "line": 30,
180
199
  "character": 9,
181
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L30"
200
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L30"
182
201
  }
183
202
  ],
184
203
  "signatures": [
185
204
  {
186
205
  "id": 14,
187
206
  "name": "forget",
207
+ "variant": "signature",
188
208
  "kind": 4096,
189
- "kindString": "Call signature",
190
209
  "flags": {},
210
+ "sources": [
211
+ {
212
+ "fileName": "forget.ts",
213
+ "line": 30,
214
+ "character": 2,
215
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L30"
216
+ }
217
+ ],
191
218
  "parameters": [
192
219
  {
193
220
  "id": 15,
194
221
  "name": "promise",
222
+ "variant": "param",
195
223
  "kind": 32768,
196
- "kindString": "Parameter",
197
224
  "flags": {},
198
225
  "type": {
199
226
  "type": "reference",
227
+ "target": {
228
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
229
+ "qualifiedName": "Promise"
230
+ },
200
231
  "typeArguments": [
201
232
  {
202
233
  "type": "intrinsic",
@@ -204,21 +235,25 @@
204
235
  }
205
236
  ],
206
237
  "name": "Promise",
207
- "qualifiedName": "Promise",
208
238
  "package": "typescript"
209
239
  }
210
240
  },
211
241
  {
212
242
  "id": 16,
213
243
  "name": "timeout",
244
+ "variant": "param",
214
245
  "kind": 32768,
215
- "kindString": "Parameter",
216
246
  "flags": {
217
247
  "isOptional": true
218
248
  },
219
249
  "type": {
220
250
  "type": "reference",
221
- "name": "ForgetTimeoutConfig"
251
+ "target": {
252
+ "sourceFileName": "src/forget.ts",
253
+ "qualifiedName": "ForgetTimeoutConfig"
254
+ },
255
+ "name": "ForgetTimeoutConfig",
256
+ "package": "@xylabs/forget"
222
257
  }
223
258
  }
224
259
  ],
@@ -262,40 +297,52 @@
262
297
  "fileName": "forget.ts",
263
298
  "line": 8,
264
299
  "character": 13,
265
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L8"
300
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L8"
266
301
  }
267
302
  ]
268
303
  },
269
304
  {
270
305
  "id": 1,
271
306
  "name": "forget",
307
+ "variant": "declaration",
272
308
  "kind": 64,
273
- "kindString": "Function",
274
309
  "flags": {},
275
310
  "sources": [
276
311
  {
277
312
  "fileName": "forget.ts",
278
313
  "line": 73,
279
314
  "character": 13,
280
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/forget.ts#L73"
315
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L73"
281
316
  }
282
317
  ],
283
318
  "signatures": [
284
319
  {
285
320
  "id": 2,
286
321
  "name": "forget",
322
+ "variant": "signature",
287
323
  "kind": 4096,
288
- "kindString": "Call signature",
289
324
  "flags": {},
325
+ "sources": [
326
+ {
327
+ "fileName": "forget.ts",
328
+ "line": 73,
329
+ "character": 22,
330
+ "url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/forget/src/forget.ts#L73"
331
+ }
332
+ ],
290
333
  "parameters": [
291
334
  {
292
335
  "id": 3,
293
336
  "name": "promise",
337
+ "variant": "param",
294
338
  "kind": 32768,
295
- "kindString": "Parameter",
296
339
  "flags": {},
297
340
  "type": {
298
341
  "type": "reference",
342
+ "target": {
343
+ "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
344
+ "qualifiedName": "Promise"
345
+ },
299
346
  "typeArguments": [
300
347
  {
301
348
  "type": "intrinsic",
@@ -303,21 +350,25 @@
303
350
  }
304
351
  ],
305
352
  "name": "Promise",
306
- "qualifiedName": "Promise",
307
353
  "package": "typescript"
308
354
  }
309
355
  },
310
356
  {
311
357
  "id": 4,
312
358
  "name": "timeout",
359
+ "variant": "param",
313
360
  "kind": 32768,
314
- "kindString": "Parameter",
315
361
  "flags": {
316
362
  "isOptional": true
317
363
  },
318
364
  "type": {
319
365
  "type": "reference",
320
- "name": "ForgetTimeoutConfig"
366
+ "target": {
367
+ "sourceFileName": "src/forget.ts",
368
+ "qualifiedName": "ForgetTimeoutConfig"
369
+ },
370
+ "name": "ForgetTimeoutConfig",
371
+ "package": "@xylabs/forget"
321
372
  }
322
373
  }
323
374
  ],
@@ -349,12 +400,101 @@
349
400
  ]
350
401
  }
351
402
  ],
352
- "sources": [
403
+ "packageName": "@xylabs/forget",
404
+ "readme": [
405
+ {
406
+ "kind": "text",
407
+ "text": "[![logo][]](https://xylabs.com)\n\n# @xylabs/sdk-js\n\n[![main-build][]][main-build-link]\n[![beta-build][]][beta-build-link]\n[![npm-badge][]][npm-link]\n[![bch-badge][]][bch-link]\n[![codacy-badge][]][codacy-link]\n[![codeclimate-badge][]][codeclimate-link]\n[![snyk-badge][]][snyk-link]\n\n## Table of Contents\n\n- [Description](#description)\n- [Install](#install)\n- [Scripts](#scripts)\n- [Maintainers](#maintainers)\n- [License](#license)\n- [Credits](#credits)\n\n## Description\n\nSDK for base code for Typescript and Javascript Libraries.\n\n## Install\n\nUsing npm:\n\n"
408
+ },
409
+ {
410
+ "kind": "code",
411
+ "text": "```sh\nnpm i --save @xylabs/sdk-js\n```"
412
+ },
413
+ {
414
+ "kind": "text",
415
+ "text": "\n\nUsing yarn:\n\n"
416
+ },
353
417
  {
354
- "fileName": "index.ts",
355
- "line": 1,
356
- "character": 0,
357
- "url": "https://github.com/xylabs/sdk-js/blob/ba7fb64/packages/forget/src/index.ts#L1"
418
+ "kind": "code",
419
+ "text": "```sh\nyarn add @xylabs/sdk-js\n```"
420
+ },
421
+ {
422
+ "kind": "text",
423
+ "text": "\n\n## Scripts\n\nSee [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md)\nfor list of shared scripts.\n\n## Maintainers\n\n- [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)\n\n## License\n\nSee the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)\n\n[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg\n[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg\n[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml\n[beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg\n[beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml\n[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg\n[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js\n[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main\n[bch-link]: https://bettercodehub.com/results/xylabs/sdk-js\n[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698\n[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade\n[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability\n[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability\n[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json\n[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json"
424
+ }
425
+ ],
426
+ "symbolIdMap": {
427
+ "0": {
428
+ "sourceFileName": "src/index.ts",
429
+ "qualifiedName": ""
430
+ },
431
+ "1": {
432
+ "sourceFileName": "src/forget.ts",
433
+ "qualifiedName": "forget"
434
+ },
435
+ "2": {
436
+ "sourceFileName": "src/forget.ts",
437
+ "qualifiedName": "forget"
438
+ },
439
+ "3": {
440
+ "sourceFileName": "src/forget.ts",
441
+ "qualifiedName": "promise"
442
+ },
443
+ "4": {
444
+ "sourceFileName": "src/forget.ts",
445
+ "qualifiedName": "timeout"
446
+ },
447
+ "5": {
448
+ "sourceFileName": "src/forget.ts",
449
+ "qualifiedName": "ForgetPromise"
450
+ },
451
+ "6": {
452
+ "sourceFileName": "src/forget.ts",
453
+ "qualifiedName": "ForgetPromise.activeForgets"
454
+ },
455
+ "7": {
456
+ "sourceFileName": "src/forget.ts",
457
+ "qualifiedName": "ForgetPromise.active"
458
+ },
459
+ "8": {
460
+ "sourceFileName": "src/forget.ts",
461
+ "qualifiedName": "ForgetPromise.active"
462
+ },
463
+ "9": {
464
+ "sourceFileName": "src/forget.ts",
465
+ "qualifiedName": "ForgetPromise.awaitInactive"
466
+ },
467
+ "10": {
468
+ "sourceFileName": "src/forget.ts",
469
+ "qualifiedName": "ForgetPromise.awaitInactive"
470
+ },
471
+ "11": {
472
+ "sourceFileName": "src/forget.ts",
473
+ "qualifiedName": "interval"
474
+ },
475
+ "12": {
476
+ "sourceFileName": "src/forget.ts",
477
+ "qualifiedName": "timeout"
478
+ },
479
+ "13": {
480
+ "sourceFileName": "src/forget.ts",
481
+ "qualifiedName": "ForgetPromise.forget"
482
+ },
483
+ "14": {
484
+ "sourceFileName": "src/forget.ts",
485
+ "qualifiedName": "ForgetPromise.forget"
486
+ },
487
+ "15": {
488
+ "sourceFileName": "src/forget.ts",
489
+ "qualifiedName": "promise"
490
+ },
491
+ "16": {
492
+ "sourceFileName": "src/forget.ts",
493
+ "qualifiedName": "timeout"
494
+ },
495
+ "19": {
496
+ "sourceFileName": "src/index.ts",
497
+ "qualifiedName": "default"
358
498
  }
359
- ]
499
+ }
360
500
  }
package/dist/esm/forget.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { delay } from '@xylabs/delay';
2
- class ForgetPromise {
2
+ export class ForgetPromise {
3
3
  static activeForgets = 0;
4
4
  static get active() {
5
5
  return this.activeForgets > 0;
@@ -54,7 +54,6 @@ class ForgetPromise {
54
54
  });
55
55
  }
56
56
  }
57
- export { ForgetPromise };
58
57
  //used to explicitly launch an async function (or Promise) with awaiting it
59
58
  export const forget = (promise, timeout) => {
60
59
  ForgetPromise.forget(promise, timeout);
package/dist/esm/forget.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"forget.js","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAOrC,MAAa,aAAa;IACxB,MAAM,CAAC,aAAa,GAAG,CAAC,CAAA;IAExB,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,GAAG,GAAG,EAAE,OAAgB;QACzD,IAAI,gBAAgB,GAAG,OAAO,CAAA;QAC9B,OAAO,IAAI,CAAC,MAAM,EAAE;YAClB,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAA;YACrB,IAAI,gBAAgB,KAAK,SAAS,EAAE;gBAClC,gBAAgB,IAAI,QAAQ,CAAA;gBAC5B,IAAI,gBAAgB,IAAI,CAAC,EAAE;oBACzB,OAAO,IAAI,CAAC,aAAa,CAAA;iBAC1B;aACF;SACF;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,OAAyB,EAAE,OAA6B;QACpE,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpB,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE;YAChC,MAAM,OAAO;iBACV,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC,CAAA;QACN,CAAC,CAAA;QAED,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,CAAC,CAAA;QAEnC,2CAA2C;QAC3C,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;gBAC7B,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC1B,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,OAAO,CAAC,KAAK,iBAAiB,CAAC,CAAA;oBAC/E,OAAO,CAAC,MAAM,EAAE,EAAE,CAAA;iBACnB;YACH,CAAC,CAAA;YACD,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC7B;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAElC,GAAG;aACA,IAAI,CAAC,GAAG,EAAE;YACT,OAAM;QACR,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,OAAM;QACR,CAAC,CAAC,CAAA;IACN,CAAC;;SA7DU,aAAa;AAgE1B,2EAA2E;AAC3E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAyB,EAAE,OAA6B,EAAE,EAAE;IACjF,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC,CAAA"}
1
+ {"version":3,"file":"forget.js","sourceRoot":"","sources":["../../src/forget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAOrC,MAAM,OAAO,aAAa;IACxB,MAAM,CAAC,aAAa,GAAG,CAAC,CAAA;IAExB,MAAM,KAAK,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,GAAG,GAAG,EAAE,OAAgB;QACzD,IAAI,gBAAgB,GAAG,OAAO,CAAA;QAC9B,OAAO,IAAI,CAAC,MAAM,EAAE;YAClB,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAA;YACrB,IAAI,gBAAgB,KAAK,SAAS,EAAE;gBAClC,gBAAgB,IAAI,QAAQ,CAAA;gBAC5B,IAAI,gBAAgB,IAAI,CAAC,EAAE;oBACzB,OAAO,IAAI,CAAC,aAAa,CAAA;iBAC1B;aACF;SACF;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,MAAM,CAAC,OAAyB,EAAE,OAA6B;QACpE,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,aAAa,EAAE,CAAA;QAEpB,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE;YAChC,MAAM,OAAO;iBACV,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,GAAG,EAAE;gBACV,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,SAAS,GAAG,IAAI,CAAA;YAClB,CAAC,CAAC,CAAA;QACN,CAAC,CAAA;QAED,MAAM,QAAQ,GAAG,CAAC,cAAc,EAAE,CAAC,CAAA;QAEnC,2CAA2C;QAC3C,IAAI,OAAO,EAAE;YACX,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;gBAC7B,MAAM,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC1B,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,CAAC,GAAG,CAAC,oCAAoC,OAAO,CAAC,KAAK,iBAAiB,CAAC,CAAA;oBAC/E,OAAO,CAAC,MAAM,EAAE,EAAE,CAAA;iBACnB;YACH,CAAC,CAAA;YACD,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;SAC7B;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAElC,GAAG;aACA,IAAI,CAAC,GAAG,EAAE;YACT,OAAM;QACR,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE;YACV,OAAM;QACR,CAAC,CAAC,CAAA;IACN,CAAC;;AAGH,2EAA2E;AAC3E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAyB,EAAE,OAA6B,EAAE,EAAE;IACjF,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AACxC,CAAC,CAAA"}
package/docs/assets/highlight.css ADDED
@@ -0,0 +1,50 @@
1
+ :root {
2
+ --light-hl-0: #795E26;
3
+ --dark-hl-0: #DCDCAA;
4
+ --light-hl-1: #000000;
5
+ --dark-hl-1: #D4D4D4;
6
+ --light-hl-2: #A31515;
7
+ --dark-hl-2: #CE9178;
8
+ --light-hl-3: #0000FF;
9
+ --dark-hl-3: #569CD6;
10
+ --light-code-background: #FFFFFF;
11
+ --dark-code-background: #1E1E1E;
12
+ }
13
+
14
+ @media (prefers-color-scheme: light) { :root {
15
+ --hl-0: var(--light-hl-0);
16
+ --hl-1: var(--light-hl-1);
17
+ --hl-2: var(--light-hl-2);
18
+ --hl-3: var(--light-hl-3);
19
+ --code-background: var(--light-code-background);
20
+ } }
21
+
22
+ @media (prefers-color-scheme: dark) { :root {
23
+ --hl-0: var(--dark-hl-0);
24
+ --hl-1: var(--dark-hl-1);
25
+ --hl-2: var(--dark-hl-2);
26
+ --hl-3: var(--dark-hl-3);
27
+ --code-background: var(--dark-code-background);
28
+ } }
29
+
30
+ :root[data-theme='light'] {
31
+ --hl-0: var(--light-hl-0);
32
+ --hl-1: var(--light-hl-1);
33
+ --hl-2: var(--light-hl-2);
34
+ --hl-3: var(--light-hl-3);
35
+ --code-background: var(--light-code-background);
36
+ }
37
+
38
+ :root[data-theme='dark'] {
39
+ --hl-0: var(--dark-hl-0);
40
+ --hl-1: var(--dark-hl-1);
41
+ --hl-2: var(--dark-hl-2);
42
+ --hl-3: var(--dark-hl-3);
43
+ --code-background: var(--dark-code-background);
44
+ }
45
+
46
+ .hl-0 { color: var(--hl-0); }
47
+ .hl-1 { color: var(--hl-1); }
48
+ .hl-2 { color: var(--hl-2); }
49
+ .hl-3 { color: var(--hl-3); }
50
+ pre, code { background: var(--code-background); }