diff options
| author | Matt Mayer <[email protected]> | 2023-03-29 20:36:46 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-29 13:36:46 +0000 |
| commit | 3562e872530b3610d95be71aa6f4f7fdfef7134f (patch) | |
| tree | c6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/datatype | |
| parent | 88e561a5490003a41665eb007c5c28ff0800ae09 (diff) | |
| download | faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip | |
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/datatype')
| -rw-r--r-- | src/modules/datatype/index.ts | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/modules/datatype/index.ts b/src/modules/datatype/index.ts index 540c4ab5..7e5946d8 100644 --- a/src/modules/datatype/index.ts +++ b/src/modules/datatype/index.ts @@ -3,6 +3,12 @@ import { deprecated } from '../../internal/deprecated'; /** * Module to generate various primitive values and data types. + * + * ### Overview + * + * Most of the methods in this module are deprecated and have been moved to other modules like [`faker.number`](https://next.fakerjs.dev/api/number.html) and [`faker.string`](https://next.fakerjs.dev/api/string.html), see individual entries for replacements. + * + * For a simple random true or false value, use [`boolean()`](https://next.fakerjs.dev/api/datatype.html#boolean). */ export class DatatypeModule { constructor(private readonly faker: Faker) { |