@xylabs/delay 5.0.83 → 5.0.86

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.
package/README.md CHANGED
@@ -15,6 +15,8 @@
15
15
 
16
16
  Base functionality used throughout XY Labs TypeScript/JavaScript libraries
17
17
 
18
+
19
+
18
20
  ## Reference
19
21
 
20
22
  **@xylabs/delay**
@@ -23,7 +25,9 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
23
25
 
24
26
  ## Functions
25
27
 
26
- - [delay](#functions/delay)
28
+ | Function | Description |
29
+ | ------ | ------ |
30
+ | [delay](#functions/delay) | Returns a promise that resolves after the specified number of milliseconds. |
27
31
 
28
32
  ### functions
29
33
 
@@ -34,19 +38,23 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
34
38
  ***
35
39
 
36
40
  ```ts
37
- function delay(ms): Promise<unknown>;
41
+ function delay(ms: number): Promise<unknown>;
38
42
  ```
39
43
 
40
- ## Parameters
44
+ Returns a promise that resolves after the specified number of milliseconds.
41
45
 
42
- ### ms
46
+ ## Parameters
43
47
 
44
- `number`
48
+ | Parameter | Type | Description |
49
+ | ------ | ------ | ------ |
50
+ | `ms` | `number` | The number of milliseconds to delay. |
45
51
 
46
52
  ## Returns
47
53
 
48
54
  `Promise`\<`unknown`\>
49
55
 
56
+ A promise that resolves after the delay.
57
+
50
58
 
51
59
  Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
52
60
 
@@ -1,2 +1,7 @@
1
+ /**
2
+ * Returns a promise that resolves after the specified number of milliseconds.
3
+ * @param ms - The number of milliseconds to delay.
4
+ * @returns A promise that resolves after the delay.
5
+ */
1
6
  export declare const delay: (ms: number) => Promise<unknown>;
2
7
  //# sourceMappingURL=delay.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"delay.d.ts","sourceRoot":"","sources":["../../src/delay.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK,GAAI,IAAI,MAAM,qBAE/B,CAAA"}
1
+ {"version":3,"file":"delay.d.ts","sourceRoot":"","sources":["../../src/delay.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAI,IAAI,MAAM,qBAE/B,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/delay.ts"],"sourcesContent":["import { setTimeoutEx } from '@xylabs/timer'\n\nexport const delay = (ms: number) => {\n return new Promise(resolve => setTimeoutEx(resolve, ms))\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAEtB,IAAM,QAAQ,CAAC,OAAe;AACnC,SAAO,IAAI,QAAQ,aAAW,aAAa,SAAS,EAAE,CAAC;AACzD;","names":[]}
1
+ {"version":3,"sources":["../../src/delay.ts"],"sourcesContent":["import { setTimeoutEx } from '@xylabs/timer'\n\n/**\n * Returns a promise that resolves after the specified number of milliseconds.\n * @param ms - The number of milliseconds to delay.\n * @returns A promise that resolves after the delay.\n */\nexport const delay = (ms: number) => {\n return new Promise(resolve => setTimeoutEx(resolve, ms))\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAOtB,IAAM,QAAQ,CAAC,OAAe;AACnC,SAAO,IAAI,QAAQ,aAAW,aAAa,SAAS,EAAE,CAAC;AACzD;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/delay",
3
- "version": "5.0.83",
3
+ "version": "5.0.86",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "delay",
@@ -42,11 +42,11 @@
42
42
  "!**/*.test.*"
43
43
  ],
44
44
  "dependencies": {
45
- "@xylabs/timer": "~5.0.83"
45
+ "@xylabs/timer": "~5.0.86"
46
46
  },
47
47
  "devDependencies": {
48
- "@xylabs/ts-scripts-yarn3": "~7.4.11",
49
- "@xylabs/tsconfig": "~7.4.11",
48
+ "@xylabs/ts-scripts-yarn3": "~7.4.16",
49
+ "@xylabs/tsconfig": "~7.4.16",
50
50
  "typescript": "~5.9.3",
51
51
  "vitest": "~4.0.18"
52
52
  },