doc: add @throws

faker-js · Mar 31, 2022 · 815f431 · 815f431
1 parent eb67b31
commit 815f431
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/datatype.ts b/src/datatype.ts
@@ -23,6 +23,8 @@ export class Datatype {
    * @param options.max Upper bound for generated number. Defaults to `min + 99999`.
    * @param options.precision Precision of the generated number. Defaults to `1`.
    *
+   * @throws When options define `max < min`
+   *
    * @example
    * faker.datatype.number() // 55422
    * faker.datatype.number(100) // 52