Refactor assertString: Faster, less nested and more consistent. (#2372)

* refactor: Refactor assertString

* refactor: Refactor assertString with unit tests

* add: Empty string unit test

* add: Null input value and more tests

* fix: Sentence correction

Author: EmersonRabelo

src/lib/util/assertString.js

@@ -1,11 +1,4 @@
 export default function assertString(input) {
-  const isString = typeof input === 'string' || input instanceof String;
-
-  if (!isString) {
-    let invalidType = typeof input;
-    if (input === null) invalidType = 'null';
-    else if (invalidType === 'object') invalidType = input.constructor.name;
-
-    throw new TypeError(`Expected a string but received a ${invalidType}`);
-  }
+  if (input === undefined || input === null) throw new TypeError(`Expected a string but received a ${input}`);
+  if (input.constructor.name !== 'String') throw new TypeError(`Expected a string but received a ${input.constructor.name}`);
 }

test/util.test.js

@@ -4,6 +4,8 @@
  */
 import assert from 'assert';
 import typeOf from '../src/lib/util/typeOf';
+import assertString from '../src/lib/util/assertString';
+
 
 describe('Util', () => {
   it('should validate different typeOf', () => {
@@ -18,3 +20,45 @@ describe('Util', () => {
     assert.notStrictEqual(typeOf([]), 'object');
   });
 });
+
+describe('assertString', () => {
+  it('Should throw an error if argument provided is an undefined', () => {
+    assert.throws(() => { assertString(); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is a null', () => {
+    assert.throws(() => { assertString(null); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is a Boolean', () => {
+    assert.throws(() => { assertString(true); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is a Date', () => {
+    assert.throws(() => { assertString(new Date()); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is a Number(NaN)', () => {
+    assert.throws(() => { assertString(NaN); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is a Number', () => {
+    assert.throws(() => { assertString(2024); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is an Object', () => {
+    assert.throws(() => { assertString({}); }, TypeError);
+  });
+
+  it('Should throw an error if argument provided is an Array', () => {
+    assert.throws(() => { assertString([]); }, TypeError);
+  });
+
+  it('Should not throw an error if the argument is an empty string', () => {
+    assert.doesNotThrow(() => { assertString(''); });
+  });
+
+  it('Should not throw an error if the argument is a String', () => {
+    assert.doesNotThrow(() => { assertString('antidisestablishmentarianism'); });
+  });
+});