Skip to content

Commit

Permalink
docs(guide): introduce module usage (#3195)
Browse files Browse the repository at this point in the history
  • Loading branch information
ST-DDT authored Oct 23, 2024
1 parent a03378b commit 48931a5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/guide/index.md
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

0 comments on commit 48931a5

Please sign in to comment.