aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2023-10-07 10:57:10 +0200
committerGitHub <[email protected]>2023-10-07 10:57:10 +0200
commitc80c035333e3c832c46dc7dcac5c86a289829e0d (patch)
treec6f71b44aad8ad47d6ebfba4942d3eb3f40ab769 /README.md
parent57bcd970883ebfa54952a0893bbaaa1c29c3c0d0 (diff)
downloadfaker-c80c035333e3c832c46dc7dcac5c86a289829e0d.tar.xz
faker-c80c035333e3c832c46dc7dcac5c86a289829e0d.zip
docs: fix outdated comment regarding multiple faker locales (#2433)
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 0 insertions, 6 deletions
diff --git a/README.md b/README.md
index ceb80928..26c858d9 100644
--- a/README.md
+++ b/README.md
@@ -79,12 +79,6 @@ export const USERS: User[] = faker.helpers.multiple(createRandomUser, {
});
```
-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 locale, while the commented-out import showcases how to import only a single locale.
-In most situations, importing a single locale 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 for [v8 (stable)](https://fakerjs.dev/api/) and [v8.\* (next)](https://next.fakerjs.dev/api/).