Skip to content

Commit 94ead23

Browse files
committed
docs(quick-start-guide): add note about top-level await in examples
1 parent e930248 commit 94ead23

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/guides/quick-start-guide.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ title: 'Quick Start Guide'
55

66
This Guide will show how to setup this package for basic use
77

8+
:::note
9+
The Examples on this page assume Top-Level async-await for readability.
10+
If Top-Level async-await is not available for your case, the code can in most cases be wrapped like:
11+
12+
```ts
13+
(async () => {
14+
// async code in where
15+
})();
16+
```
17+
18+
:::
19+
820
## Requirements
921

1022
- NodeJS: 12.22+

0 commit comments

Comments
 (0)