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(guide): introduce module usage #3195

Merged
merged 4 commits into from
Oct 23, 2024
Merged

docs(guide): introduce module usage #3195

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2bddda
docs(guide): introduce module usage
ST-DDT Oct 18, 2024
2841a07
chore: apply suggestions
ST-DDT Oct 18, 2024
2fadc6b
Merge branch 'next' into docs/guide/module-usage
ST-DDT Oct 20, 2024
b7f5d6e
Merge branch 'next' into docs/guide/module-usage
ST-DDT Oct 23, 2024
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
12 changes: 12 additions & 0 deletions docs/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ yarn add @faker-js/faker --dev

:::

## Faker Modules

Faker has three types of modules:

- Modules for basic datatypes: [`datatype`](/api/datatype), [`date`](/api/date), [`number`](/api/number) and [`string`](/api/string)
- Topic specific modules, such as [`animal`](/api/animal), [`food`](/api/food) and many more
- Lastly, the [`helpers`](/api/datatype) module, with various utility methods to use with your own data (or data generated by other Faker methods)

For a full list of modules, go to our [Api Search](/api/) page.

If you would like to know how to use Faker, go to our [Usage Guide](/guide/usage) page.

## Community

If you have questions or need help, reach out to the community via [Discord](https://chat.fakerjs.dev) and [GitHub Discussions](https://github.com/faker-js/faker/discussions).
Expand Down