diff options
| author | Matt Mayer <[email protected]> | 2022-12-05 17:03:32 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-12-05 10:03:32 +0000 |
| commit | c0badd9a641dbc6ba1c405635309ca103789c343 (patch) | |
| tree | 075235f3468e87289bcf7de517ce0d06eaa42864 /src/modules | |
| parent | 03c5fea2e0b97545a41dbee45720f778d796cd1e (diff) | |
| download | faker-c0badd9a641dbc6ba1c405635309ca103789c343.tar.xz faker-c0badd9a641dbc6ba1c405635309ca103789c343.zip | |
docs(datatype): add missing `@see` tags for deprecated methods (#1608)
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/datatype/index.ts | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/modules/datatype/index.ts b/src/modules/datatype/index.ts index 22ee1bfe..70a539d7 100644 --- a/src/modules/datatype/index.ts +++ b/src/modules/datatype/index.ts @@ -26,6 +26,9 @@ export class DatatypeModule { * * @throws When options define `max < min`. * + * @see faker.number.int() for the default precision of `1` + * @see faker.number.float() for a custom precision + * * @example * faker.datatype.number() // 55422 * faker.datatype.number(100) // 52 @@ -36,7 +39,7 @@ export class DatatypeModule { * * @since 5.5.0 * - * @deprecated Use `faker.number.int()` instead. + * @deprecated Use `faker.number.int()` or `faker.number.float()` instead. */ number( options: number | { min?: number; max?: number; precision?: number } = 99999 @@ -65,6 +68,8 @@ export class DatatypeModule { * @param options.max Upper bound for generated number. Defaults to `99999`. * @param options.precision Precision of the generated number. Defaults to `0.01`. * + * @see faker.number.float() + * * @example * faker.datatype.float() // 51696.36 * faker.datatype.float(0.1) // 52023.2 @@ -295,6 +300,8 @@ export class DatatypeModule { * * @throws When options define `max < min`. * + * @see faker.number.bigInt() + * * @example * faker.datatype.bigInt() // 55422n * faker.datatype.bigInt(100n) // 52n |