feat(guards): isExceptionId

Author: unicornware

packages/exceptions/src/guards/__tests__/is-exception-id.guard.spec.ts

@@ -0,0 +1,26 @@
+import ExceptionCode from '@packages/exceptions/enums/exception-code.enum'
+import ExceptionId from '@packages/exceptions/enums/exception-id.enum'
+import type { Testcase } from '@tests/utils/types'
+import testSubject from '../is-exception-id.guard'
+
+/**
+ * @file Unit Tests - isExceptionId
+ * @module exceptions/guards/tests/unit/isExceptionId
+ */
+
+describe('unit:guards/isExceptionId', () => {
+  type Case = Testcase<boolean> & { value: any }
+
+  const cases: Case[] = [
+    { expected: false, value: ExceptionCode.UNAUTHORIZED },
+    { expected: true, value: ExceptionId.I_AM_A_TEAPOT }
+  ]
+
+  it.each<Case>(cases)('should return $expected given $value', testcase => {
+    // Arrange
+    const { expected, value } = testcase
+
+    // Act + Expect
+    expect(testSubject(value)).toBe(expected)
+  })
+})

packages/exceptions/src/guards/index.ts

@@ -4,5 +4,6 @@
  */
 
 export { default as isExceptionCode } from './is-exception-code.guard'
+export { default as isExceptionId } from './is-exception-id.guard'
 export { default as isExceptionJSON } from './is-exception-json.guard'
 export { default as isException } from './is-exception.guard'

packages/exceptions/src/guards/is-exception-id.guard.ts

@@ -0,0 +1,18 @@
+import ExceptionId from '@packages/exceptions/enums/exception-id.enum'
+
+/**
+ * @file Type Guards - isExceptionId
+ * @module exceptions/guards/isExceptionId
+ */
+
+/**
+ * Checks if `value` is a valid `ExceptionId`.
+ *
+ * @param {any} [value] - Value to check
+ * @return {boolean} `true` if `ExceptionId`, `false` otherwise
+ */
+const isExceptionId = (value: any = {}): value is ExceptionId => {
+  return Object.keys(ExceptionId).includes(value)
+}
+
+export default isExceptionId