feat: determineSpecificType

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

Author: unicornware

README.md

@@ -7,7 +7,7 @@
 [![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)
 [![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)
 
-Create [Node.js errors][1]
+Utilities for creating [Node.js errors][1]
 
 ## Contents
 
@@ -21,7 +21,7 @@ Create [Node.js errors][1]
 
 ## What is this?
 
-This package is a utility for creating [Node.js errors][1].
+This package provides utilities for creating [Node.js errors][1].
 
 ## When should I use this?
 

build.config.ts

@@ -12,9 +12,9 @@ import pkg from './package.json' assert { type: 'json' }
  * @const {Config} config
  */
 const config: Config = defineBuildConfig({
-  platform: 'node',
+  sourcemap: true,
+  sourcesContent: false,
   target: 'node' + pkg.engines.node.replace(/^\D+/, ''),
-  treeShaking: true,
   tsconfig: 'tsconfig.build.json'
 })
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flex-development/create-node-error",
-  "description": "Utility for creating Node.js errors",
+  "description": "Utilities for creating Node.js errors",
   "version": "0.0.0",
   "keywords": [
     "error",
@@ -63,6 +63,9 @@
     "typecheck": "vitest typecheck --run",
     "typecheck:watch": "vitest typecheck"
   },
+  "dependencies": {
+    "node-inspect-extracted": "2.0.0"
+  },
   "devDependencies": {
     "@commitlint/cli": "17.3.0",
     "@commitlint/config-conventional": "17.3.0",
@@ -131,6 +134,9 @@
     "vitest-github-actions-reporter": "0.9.0",
     "yaml-eslint-parser": "1.1.0"
   },
+  "bundleDependencies": [
+    "node-inspect-extracted"
+  ],
   "resolutions": {
     "@ardatan/sync-fetch": "larsgw/sync-fetch#head=worker_threads",
     "@flex-development/tutils": "6.0.0-alpha.7",

src/__tests__/determine-specific-type.spec.ts

@@ -0,0 +1,85 @@
+/**
+ * @file Unit Tests - determineSpecificType
+ * @module create-node-error/tests/unit/determineSpecificType
+ */
+
+import { inspect } from 'node-inspect-extracted'
+import testSubject from '../determine-specific-type'
+
+describe('unit:determineSpecificType', () => {
+  it('should detect bigint', () => {
+    // Arrange
+    const value: bigint = faker.datatype.bigInt(13)
+    const expected: string = `type bigint (${inspect(value, {
+      colors: false
+    })})`
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect boolean', () => {
+    // Arrange
+    const value: unknown = faker.datatype.boolean()
+    const expected: string = `type boolean (${value})`
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect function', () => {
+    // Arrange
+    const value: unknown = vi.fn()
+    const expected: string = 'function spy'
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect instance object', () => {
+    // Arrange
+    const value: unknown = faker.datatype.datetime()
+    const expected: string = 'an instance of Date'
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect null', () => {
+    expect(testSubject(null)).to.equal('null')
+  })
+
+  it('should detect number', () => {
+    // Arrange
+    const value: unknown = faker.datatype.number(13)
+    const expected: string = `type number (${value})`
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect string', () => {
+    // Arrange
+    const value: unknown = faker.datatype.string(30)
+    const inspected: string = inspect(value, { colors: false })
+    const expected: string = `type string (${inspected.slice(0, 25)}...)`
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect symbol', () => {
+    // Arrange
+    const value: unknown = Symbol('kIsNodeError')
+    const expected: string = `type symbol (${inspect(value, {
+      colors: false
+    })})`
+
+    // Act + Expect
+    expect(testSubject(value)).to.equal(expected)
+  })
+
+  it('should detect undefined', () => {
+    expect(testSubject(undefined)).to.equal('undefined')
+  })
+})

src/determine-specific-type.ts

@@ -0,0 +1,53 @@
+/**
+ * @file determineSpecificType
+ * @module create-node-error/determineSpecificType
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L878-L896
+ */
+
+import { inspect } from 'node-inspect-extracted'
+
+/**
+ * Determines the specific type of a value for type-mismatch errors.
+ *
+ * @param {unknown} value - Value to detect type of
+ * @return {string} Specific type of `value`
+ */
+function determineSpecificType(value: unknown): string {
+  /**
+   * Specific type of `value`.
+   *
+   * @var {string} type
+   */
+  let type: string = ''
+
+  switch (true) {
+    case typeof value === 'function':
+      type = `function ${(value as FunctionConstructor).name}`
+      break
+    case typeof value === 'object':
+      type = value?.constructor?.name
+        ? `an instance of ${value.constructor.name}`
+        : inspect(value, { depth: -1 })
+      break
+    case typeof value === 'undefined':
+      type = typeof value
+      break
+    default:
+      /**
+       * String representation of {@linkcode value}.
+       *
+       * @var {string} inspected
+       */
+      let inspected: string = inspect(value, { colors: false })
+
+      // trim string representation of value
+      if (inspected.length > 28) inspected = inspected.slice(0, 25) + '...'
+
+      type = `type ${typeof value} (${inspected})`
+      break
+  }
+
+  return type
+}
+
+export default determineSpecificType

src/index.ts

@@ -3,4 +3,4 @@
  * @module create-node-error
  */
 
-export {}
+export { default as determineSpecificType } from './determine-specific-type'

yarn.lock

@@ -1043,6 +1043,7 @@ __metadata:
     is-ci: "npm:3.0.1"
     jsonc-eslint-parser: "npm:2.1.0"
     lint-staged: "npm:13.1.0"
+    node-inspect-extracted: "npm:2.0.0"
     node-notifier: "npm:10.0.1"
     prettier: "npm:2.8.1"
     prettier-plugin-sh: "npm:0.12.8"
@@ -6375,6 +6376,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"node-inspect-extracted@npm:2.0.0":
+  version: 2.0.0
+  resolution: "node-inspect-extracted@npm:2.0.0"
+  checksum: d99c560d4687695f191d27585877893428101082d8ce1b52d79e968650b03c626cd3472f98cae98f17c98859ed0aa1e1a53954d82ba04659115ebb4e6e5565b4
+  languageName: node
+  linkType: hard
+
 "node-notifier@npm:10.0.1":
   version: 10.0.1
   resolution: "node-notifier@npm:10.0.1"