diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | docs/guide/localization.md | 5 | ||||
| -rw-r--r-- | docs/guide/usage.md | 9 |
3 files changed, 19 insertions, 1 deletions
@@ -65,6 +65,12 @@ Array.from({ length: 10 }).forEach(() => { }); ``` +The above code indicates a basic usage of Faker. +The point of interest is the import statements at the top. +The first import indicates how one can import the entirety of Faker, which includes every local, while the commented-out import showcases how to import only a single local. +In most situations, importing a single local is preferable for performance because some testing frameworks reload imports for every test file, which causes startup latencies to add up quickly. +Thus, limiting the import to a single locale can speed up startup times. + ## 💎 Modules An in-depth overview of the API methods is available in the [documentation](https://fakerjs.dev/guide/). diff --git a/docs/guide/localization.md b/docs/guide/localization.md index f6858378..1412ec00 100644 --- a/docs/guide/localization.md +++ b/docs/guide/localization.md @@ -28,6 +28,11 @@ The English locales are around 600 KB in size. All locales together are around 5 MB in size. ::: +:::tip Note +Some locales have limited coverage and rely more heavily on the English locale as the source for features they currently do not have. +However, in most cases, using a specific locale will be beneficial in the long term as specifying a locale reduces the time necessary for startup, which has a compounding effect on testing frameworks that reload the imports every execution. +::: + ## Available locales <!-- LOCALES-AUTO-GENERATED-START --> 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 |