docs: add missing throw descriptions in JSDocs (#2560)

2 files changed, 48 insertions, 1 deletions

diff --git a/test/modules/datatype.spec.ts b/test/modules/datatype.spec.ts
index b4d154f4..3d65797d 100644
--- a/test/modules/datatype.spec.ts
+++ b/test/modules/datatype.spec.ts
@@ -232,6 +232,12 @@ describe('datatype', () => {
             new FakerError(`Max ${max} should be greater than min ${min}.`)
           );
         });
+
+        it('should throw when precision is negative', () => {
+          expect(() => {
+            faker.datatype.number({ precision: -0.01 });
+          }).toThrow(new FakerError('Precision should be greater than 0.'));
+        });
       });
 
       describe('float', () => {
@@ -306,6 +312,23 @@ describe('datatype', () => {
           expect(opts.min).toBe(min);
           expect(opts.max).toBe(max);
         });
+
+        it('should throw when min > max', () => {
+          const min = 10;
+          const max = 9;
+
+          expect(() => {
+            faker.datatype.number({ min, max });
+          }).toThrow(
+            new FakerError(`Max ${max} should be greater than min ${min}.`)
+          );
+        });
+
+        it('should throw when precision is negative', () => {
+          expect(() => {
+            faker.datatype.float({ precision: -0.01 });
+          }).toThrow(new FakerError('Precision should be greater than 0.'));
+        });
       });
 
       describe('datetime', () => {
diff --git a/test/modules/number.spec.ts b/test/modules/number.spec.ts
index 699200b2..97061d56 100644
--- a/test/modules/number.spec.ts
+++ b/test/modules/number.spec.ts
@@ -305,7 +305,7 @@ describe('number', () => {
         return [...str].every((char) => char === '0' || char === '1');
       }
 
-      it('enerates single binary character when no additional argument was provided', () => {
+      it('generates single binary character when no additional argument was provided', () => {
         const binary = faker.number.binary();
 
         expect(binary).toBeTypeOf('string');
@@ -345,6 +345,14 @@ describe('number', () => {
           new FakerError(`Max ${max} should be greater than min ${min}.`)
         );
       });
+
+      it('should throw when there is no integer between min and max', () => {
+        expect(() => {
+          faker.number.binary({ min: 2.1, max: 2.9 });
+        }).toThrow(
+          new FakerError(`No integer value between 2.1 and 2.9 found.`)
+        );
+      });
     });
 
     describe('octal', () => {
@@ -388,6 +396,14 @@ describe('number', () => {
           new FakerError(`Max ${max} should be greater than min ${min}.`)
         );
       });
+
+      it('should throw when there is no integer between min and max', () => {
+        expect(() => {
+          faker.number.octal({ min: 2.1, max: 2.9 });
+        }).toThrow(
+          new FakerError(`No integer value between 2.1 and 2.9 found.`)
+        );
+      });
     });
 
     describe('hex', () => {
@@ -428,6 +444,14 @@ describe('number', () => {
           new FakerError(`Max ${max} should be greater than min ${min}.`)
         );
       });
+
+      it('should throw when there is no integer between min and max', () => {
+        expect(() => {
+          faker.number.hex({ min: 2.1, max: 2.9 });
+        }).toThrow(
+          new FakerError(`No integer value between 2.1 and 2.9 found.`)
+        );
+      });
     });
 
     describe('bigInt', () => {