mirror of
https://github.com/robonen/tools.git
synced 2026-03-20 10:54:44 +00:00
feat(packages/stdlib): add sleep async util
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
export * from './sleep';
|
||||
export * from './tryIt';
|
||||
|
||||
19
packages/stdlib/src/async/sleep/index.test.ts
Normal file
19
packages/stdlib/src/async/sleep/index.test.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest';
|
||||
import { sleep } from '.';
|
||||
|
||||
describe('sleep', () => {
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers({ shouldAdvanceTime: true });
|
||||
});
|
||||
|
||||
it('delay execution by the specified amount of time', async () => {
|
||||
const start = performance.now();
|
||||
const delay = 100;
|
||||
|
||||
await sleep(delay);
|
||||
|
||||
const end = performance.now();
|
||||
|
||||
expect(end - start).toBeGreaterThanOrEqual(delay);
|
||||
});
|
||||
});
|
||||
19
packages/stdlib/src/async/sleep/index.ts
Normal file
19
packages/stdlib/src/async/sleep/index.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
/**
|
||||
* @name sleep
|
||||
* @category Async
|
||||
* @description Delays the execution of the current function by the specified amount of time
|
||||
*
|
||||
* @param {number} ms - The amount of time to delay the execution of the current function
|
||||
* @returns {Promise<void>} - A promise that resolves after the specified amount of time
|
||||
*
|
||||
* @example
|
||||
* await sleep(1000);
|
||||
*
|
||||
* @example
|
||||
* sleep(1000).then(() => {
|
||||
* console.log('Hello, World!');
|
||||
* });
|
||||
*/
|
||||
export function sleep(ms: number): Promise<void> {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
}
|
||||
Reference in New Issue
Block a user