diff options
author | 2023-07-26 14:59:39 -0700 | |
---|---|---|
committer | 2023-07-26 14:59:39 -0700 | |
commit | 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 (patch) | |
tree | fc1d2f47309c0345a850933496baa40d94bfdcbb /docs/guides/util/sleep.md | |
parent | 6bfee02301a2e2a0b79339974af0445eb5a2688f (diff) | |
download | bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.gz bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.tar.zst bun-4c89c60867591b50e0b31bf5009fd5ad6a3cebe1.zip |
Add files (#3826)
Diffstat (limited to 'docs/guides/util/sleep.md')
-rw-r--r-- | docs/guides/util/sleep.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/guides/util/sleep.md b/docs/guides/util/sleep.md new file mode 100644 index 000000000..dbc39c057 --- /dev/null +++ b/docs/guides/util/sleep.md @@ -0,0 +1,22 @@ +--- +name: Sleep for a fixed number of milliseconds +--- + +The `Bun.sleep` method provides a convenient way to create a void `Promise` that resolves in a fixed number of milliseconds. + +```ts +// sleep for 1 second +await Bun.sleep(1000); +``` + +--- + +Internally, this is equivalent to the following snippet that uses [`setTimeout`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout). + +```ts +await new Promise((resolve) => setTimeout(resolve, ms)); +``` + +--- + +See [Docs > API > Utils](/docs/api/utils) for more useful utilities. |