diff options
| author | ST-DDT <[email protected]> | 2024-10-23 14:53:46 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-10-23 12:53:46 +0000 |
| commit | 48931a56b761352a35d2f7f6c1240231a5df5efd (patch) | |
| tree | eec5e5b7bb7fc10ed352abc01721a5baa3d6faab /docs/guide | |
| parent | a03378bf0869b845c704914447facc06dbb1bc48 (diff) | |
| download | faker-48931a56b761352a35d2f7f6c1240231a5df5efd.tar.xz faker-48931a56b761352a35d2f7f6c1240231a5df5efd.zip | |
docs(guide): introduce module usage (#3195)
Diffstat (limited to 'docs/guide')
| -rw-r--r-- | docs/guide/index.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/guide/index.md b/docs/guide/index.md index 7871cb2b..bada358a 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -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). |