Skip to content

docs: split custom Faker instance example #3585

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

Open
pkuczynski wants to merge 6 commits into
base: next
Choose a base branch
from
Open

docs: split custom Faker instance example #3585

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
66227ac
docs: split custom Faker instance example
pkuczynski Aug 5, 2025
b46fc5e
next try
pkuczynski Aug 5, 2025
104926e
try again
pkuczynski Aug 5, 2025
2b1382d
try again with extra line
pkuczynski Aug 5, 2025
093035e
revert extra line
pkuczynski Aug 5, 2025
9352293
try without second @example tag
pkuczynski Aug 5, 2025
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: 4 additions & 2 deletions src/faker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,13 @@ import { mergeLocales } from './utils/merge-locales';
*
* faker.person.firstName(); // 'John'
* faker.person.lastName(); // 'Doe'
* @example
*
* //
* // Create Faker instance with only `es` data and no `en` fallback (=> smaller bundle size):
* //
* import { Faker, es } from '@faker-js/faker';
* // const { Faker, es } = require('@faker-js/faker');
*
* // create a Faker instance with only es data and no en fallback (=> smaller bundle size)
* const customFaker = new Faker({ locale: [es] });
*
* customFaker.person.firstName(); // 'Javier'
Expand Down
Loading