feat(guards): isJsonPrimitive

Signed-off-by: Lexus Drumgold <[email protected]>

src/guards/__tests__/is-json-primitive.spec-d.ts

@@ -0,0 +1,13 @@
+/**
+ * @file Type Tests - isJsonPrimitive
+ * @module tutils/guards/tests/unit-d/isJsonPrimitive
+ */
+
+import type { JsonPrimitive } from '#src/types'
+import type testSubject from '../is-json-primitive'
+
+describe('unit-d:guards/isJsonPrimitive', () => {
+  it('should guard JsonPrimitive', () => {
+    expectTypeOf<typeof testSubject>().guards.toEqualTypeOf<JsonPrimitive>()
+  })
+})

src/guards/__tests__/is-json-primitive.spec.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Unit Tests - isJsonPrimitive
+ * @module tutils/guards/tests/unit/isJsonPrimitive
+ */
+
+import testSubject from '../is-json-primitive'
+
+describe('unit:guards/isJsonPrimitive', () => {
+  it('should return false if value is not JSON primitive', () => {
+    expect(testSubject(faker.datatype.array())).to.be.false
+  })
+
+  it('should return true if value is JSON primitive', () => {
+    // Arrange
+    const cases: Parameters<typeof testSubject>[] = [
+      [faker.datatype.boolean()],
+      [faker.number.int()],
+      [faker.string.uuid()],
+      [null]
+    ]
+
+    // Act + Expect
+    cases.forEach(([value]) => expect(testSubject(value)).to.be.true)
+  })
+})

src/guards/index.ts

@@ -12,6 +12,7 @@ export { default as isEmptyValue } from './is-empty-value'
 export { default as isFloat } from './is-float'
 export { default as isFunction } from './is-function'
 export { default as isInt } from './is-int'
+export { default as isJsonPrimitive } from './is-json-primitive'
 export { default as isJwtType } from './is-jwt-type'
 export { default as isNIL } from './is-nil'
 export { default as isNodeEnv } from './is-node-env'

src/guards/is-json-primitive.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Type Guards - isJsonPrimitive
+ * @module tutils/guards/isJsonPrimitive
+ */
+
+import type { JsonPrimitive } from '#src/types'
+import isBoolean from './is-boolean'
+import isNull from './is-null'
+import isNumber from './is-number'
+import isString from './is-string'
+
+/**
+ * Checks if the given `value` is a [primitive][1] [`JSON` value][2].
+ *
+ * [1]: https://developer.mozilla.org/docs/Glossary/Primitive
+ * [2]: https://restfulapi.net/json-data-types
+ *
+ * @param {unknown} value - Value to evaluate
+ * @return {value is JsonPrimitive} `true` if `value` is primitive JSON value
+ */
+const isJsonPrimitive = (value: unknown): value is JsonPrimitive => {
+  return isBoolean(value) || isNumber(value) || isNull(value) || isString(value)
+}
+
+export default isJsonPrimitive