diff options
| author | conner-c <[email protected]> | 2022-12-07 14:35:15 -0600 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-12-07 20:35:15 +0000 |
| commit | d0ff3fecc5e6eba355f64d11eca4549a405386c4 (patch) | |
| tree | 1290481432123571c00f01f86f11c9398bdd4025 /docs/guide/usage.md | |
| parent | f06126a1ba8515d6e0b7733999d5cd2f8849be7a (diff) | |
| download | faker-d0ff3fecc5e6eba355f64d11eca4549a405386c4.tar.xz faker-d0ff3fecc5e6eba355f64d11eca4549a405386c4.zip | |
docs: include hints on specifying a locale can help startup time (#1629)
Co-authored-by: ST-DDT <[email protected]>
Diffstat (limited to 'docs/guide/usage.md')
| -rw-r--r-- | docs/guide/usage.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 63a0c183..6d325a0b 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -6,11 +6,18 @@ Using Faker is as easy as importing it from `@faker-js/faker`. ```js import { faker } from '@faker-js/faker'; - +// or, if desiring only a specific locale +// import { faker } from '@faker-js/faker/locale/de' const randomName = faker.person.fullName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // [email protected] ``` +:::tip Note +Using the first import statement will load every locale into memory. +As such, start-up times and performance may be slow. +Thus, by declaring a locale in the import, one can increase performance and reduce the time on start-up. +::: + Or if you're using CommonJS: ```js |
