feat: add checkBounds util function.

Author: ghosind

src/utils.ts

@@ -14,6 +14,21 @@ import { DynamicBuffer } from './dynamicBuffer';
  */
 export const isDynamicBuffer = (val: any) => val instanceof DynamicBuffer;
 
+/**
+ * Check the value is greater or equals to the minimum value, and less or equals to the maximum
+ * value. It'll throw an error if the value is not in the range.
+ *
+ * @param field The field name.
+ * @param value The value to check.
+ * @param min The allowed minimum value (included) of this value.
+ * @param max The allowed maximum value (included) of this value.
+ */
+export const checkBounds = (field: string, value: number, min: number, max: number) => {
+  if (value < min || value > max) {
+    throw new RangeError(`${field} is out of bounds`);
+  }
+};
+
 /**
  * Check the value in the required range, and throw an error if not satisfy the range requirement.
  *
@@ -24,11 +39,11 @@ export const isDynamicBuffer = (val: any) => val instanceof DynamicBuffer;
  */
 export const checkRange = (field: string, value: number, min?: number, max?: number) => {
   if (min !== undefined && value < min) {
-    throw RangeError(`The value of '${field}' is out of range. It must be >= ${min}. Received ${value}`);
+    throw new RangeError(`The value of '${field}' is out of range. It must be >= ${min}. Received ${value}`);
   }
 
   if (max !== undefined && value > max) {
-    throw RangeError(`The value of '${field}' is out of range. It must be <= ${max}. Received ${value}`);
+    throw new RangeError(`The value of '${field}' is out of range. It must be <= ${max}. Received ${value}`);
   }
 };
 

test/util.spec.ts

@@ -2,7 +2,12 @@ import assert from 'assert';
 import { describe, it } from 'mocha';
 
 import { DynamicBuffer } from '../src';
-import { isDynamicBuffer, checkRange, swap } from '../src/utils';
+import {
+  isDynamicBuffer,
+  checkBounds,
+  checkRange,
+  swap,
+} from '../src/utils';
 
 describe('Method isDynamicBuffer test', () => {
   it('Test isDynamicBuffer util method', () => {
@@ -11,6 +16,22 @@ describe('Method isDynamicBuffer test', () => {
   });
 });
 
+describe('Method checkBounds test', () => {
+  it('Test checkBounds', () => {
+    assert.doesNotThrow(() => {
+      checkBounds('valid', 0, 0, 5);
+    });
+
+    assert.throws(() => {
+      checkBounds('less', -5, 0, 5);
+    });
+
+    assert.throws(() => {
+      checkBounds('greater', 10, 0, 5);
+    });
+  });
+});
+
 describe('Method checkRange test', () => {
   it('Test checkRange', () => {
     assert.doesNotThrow(() => {