Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix outdated comment regarding multiple faker locales #2433

Merged
merged 6 commits into from
Oct 7, 2023
Merged

docs: fix outdated comment regarding multiple faker locales #2433

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0de9915
docs: fix outdated comment regarding multiple faker locales
ST-DDT Oct 5, 2023
f19712c
Merge branch 'next' into docs/readme-cleanup
ST-DDT Oct 6, 2023
01410f4
Merge branch 'next' into docs/readme-cleanup
ST-DDT Oct 6, 2023
683a837
Merge branch 'next' into docs/readme-cleanup
ST-DDT Oct 6, 2023
f639092
Merge branch 'next' into docs/readme-cleanup
ST-DDT Oct 7, 2023
9c7bac4
Merge branch 'next' into docs/readme-cleanup
ST-DDT Oct 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down