From 815f431044fccb1c87507d02bc8aa1d1b61d7217 Mon Sep 17 00:00:00 2001 From: Piotr Kuczynski Date: Thu, 31 Mar 2022 11:25:37 +0200 Subject: [PATCH] doc: add @throws --- src/datatype.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/datatype.ts b/src/datatype.ts index 6a8f2db6cc6..79b0b61c1c1 100644 --- 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