feat(enums): SystemErrorCode

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

Author: unicornware

.cspell.json

@@ -43,5 +43,15 @@
   "useGitignore": true,
   "usePnP": false,
   "version": "0.2",
-  "words": ["Odfijos", "fldv"]
+  "words": [
+    "ECHARSET",
+    "EFTYPE",
+    "EHOSTDOWN",
+    "ENONET",
+    "EREMOTEIO",
+    "ESHUTDOWN",
+    "ESOCKTNOSUPPORT",
+    "Odfijos",
+    "fldv"
+  ]
 }

README.md

@@ -321,6 +321,7 @@ This package is fully typed with [TypeScript][8]. It exports the following defin
 ### Enums
 
 - [`ErrorCode`](src/enums/error-code.ts)
+- [`SystemErrorCode`](src/enums/error-code-system.ts)
 
 ### Type Definitions
 

src/enums/__tests__/error-code-system.spec-d.ts

@@ -0,0 +1,18 @@
+/**
+ * @file Type Tests - SystemErrorCode
+ * @module errnode/enums/tests/unit-d/SystemErrorCode
+ */
+
+import type TestSubject from '../error-code-system'
+
+describe('unit-d:enums/SystemErrorCode', () => {
+  it('should have members of type Uppercase<string>', () => {
+    // Arrange
+    type Key = keyof typeof TestSubject
+
+    // Expect
+    expectTypeOf<Key>().toMatchTypeOf<Uppercase<string>>()
+    expectTypeOf<TestSubject>().toMatchTypeOf<Key>()
+    expectTypeOf<typeof TestSubject[Key]>().toEqualTypeOf<TestSubject>()
+  })
+})

src/enums/__tests__/error-code-system.spec.ts

@@ -0,0 +1,21 @@
+/**
+ * @file Unit Tests - SystemErrorCode
+ * @module errnode/enums/tests/unit/SystemErrorCode
+ */
+
+import { getSystemErrorMap } from 'node:util'
+import TestSubject from '../error-code-system'
+
+describe('unit:enums/SystemErrorCode', () => {
+  let cases: string[]
+
+  beforeAll(() => {
+    cases = [...getSystemErrorMap().values()].map(([code]) => code)
+  })
+
+  it('should map system error codes to system error codes', () => {
+    cases.forEach(code => {
+      expect(TestSubject).to.have.property(code).equal(code)
+    })
+  })
+})

src/enums/error-code-system.ts

@@ -0,0 +1,118 @@
+/**
+ * @file Enums - SystemErrorCode
+ * @module errnode/enums/SystemErrorCode
+ */
+
+/**
+ * System error codes.
+ *
+ * @see https://github.com/nodejs/node/blob/v19.3.0/deps/uv/include/uv.h#L72-L154
+ *
+ * @enum {Uppercase<string>}
+ */
+enum SystemErrorCode {
+  E2BIG = 'E2BIG',
+  EACCES = 'EACCES',
+  EADDRINUSE = 'EADDRINUSE',
+  EADDRNOTAVAIL = 'EADDRNOTAVAIL',
+  EAFNOSUPPORT = 'EAFNOSUPPORT',
+  EAGAIN = 'EAGAIN',
+  EAI_ADDRFAMILY = 'EAI_ADDRFAMILY',
+  EAI_AGAIN = 'EAI_AGAIN',
+  EAI_BADFLAGS = 'EAI_BADFLAGS',
+  EAI_BADHINTS = 'EAI_BADHINTS',
+  EAI_CANCELED = 'EAI_CANCELED',
+  EAI_FAIL = 'EAI_FAIL',
+  EAI_FAMILY = 'EAI_FAMILY',
+  EAI_MEMORY = 'EAI_MEMORY',
+  EAI_NODATA = 'EAI_NODATA',
+  EAI_NONAME = 'EAI_NONAME',
+  EAI_OVERFLOW = 'EAI_OVERFLOW',
+  EAI_PROTOCOL = 'EAI_PROTOCOL',
+  EAI_SERVICE = 'EAI_SERVICE',
+  EAI_SOCKTYPE = 'EAI_SOCKTYPE',
+  EALREADY = 'EALREADY',
+  EBADF = 'EBADF',
+  EBADMSG = 'EBADMSG',
+  EBUSY = 'EBUSY',
+  ECANCELED = 'ECANCELED',
+  ECHARSET = 'ECHARSET',
+  ECHILD = 'ECHILD',
+  ECONNABORTED = 'ECONNABORTED',
+  ECONNREFUSED = 'ECONNREFUSED',
+  ECONNRESET = 'ECONNRESET',
+  EDEADLK = 'EDEADLK',
+  EDESTADDRREQ = 'EDESTADDRREQ',
+  EDOM = 'EDOM',
+  EDQUOT = 'EDQUOT',
+  EEXIST = 'EEXIST',
+  EFAULT = 'EFAULT',
+  EFBIG = 'EFBIG',
+  EFTYPE = 'EFTYPE',
+  EHOSTDOWN = 'EHOSTDOWN',
+  EHOSTUNREACH = 'EHOSTUNREACH',
+  EIDRM = 'EIDRM',
+  EILSEQ = 'EILSEQ',
+  EINPROGRESS = 'EINPROGRESS',
+  EINTR = 'EINTR',
+  EINVAL = 'EINVAL',
+  EIO = 'EIO',
+  EISCONN = 'EISCONN',
+  EISDIR = 'EISDIR',
+  ELOOP = 'ELOOP',
+  EMFILE = 'EMFILE',
+  EMLINK = 'EMLINK',
+  EMSGSIZE = 'EMSGSIZE',
+  EMULTIHOP = 'EMULTIHOP',
+  ENAMETOOLONG = 'ENAMETOOLONG',
+  ENETDOWN = 'ENETDOWN',
+  ENETRESET = 'ENETRESET',
+  ENETUNREACH = 'ENETUNREACH',
+  ENFILE = 'ENFILE',
+  ENOBUFS = 'ENOBUFS',
+  ENODATA = 'ENODATA',
+  ENODEV = 'ENODEV',
+  ENOENT = 'ENOENT',
+  ENOEXEC = 'ENOEXEC',
+  ENOLCK = 'ENOLCK',
+  ENOLINK = 'ENOLINK',
+  ENOMEM = 'ENOMEM',
+  ENOMSG = 'ENOMSG',
+  ENONET = 'ENONET',
+  ENOPROTOOPT = 'ENOPROTOOPT',
+  ENOSPC = 'ENOSPC',
+  ENOSR = 'ENOSR',
+  ENOSTR = 'ENOSTR',
+  ENOSYS = 'ENOSYS',
+  ENOTCONN = 'ENOTCONN',
+  ENOTDIR = 'ENOTDIR',
+  ENOTEMPTY = 'ENOTEMPTY',
+  ENOTSOCK = 'ENOTSOCK',
+  ENOTSUP = 'ENOTSUP',
+  ENOTTY = 'ENOTTY',
+  ENXIO = 'ENXIO',
+  EOF = 'EOF',
+  EOPNOTSUPP = 'EOPNOTSUPP',
+  EOVERFLOW = 'EOVERFLOW',
+  EPERM = 'EPERM',
+  EPIPE = 'EPIPE',
+  EPROTO = 'EPROTO',
+  EPROTONOSUPPORT = 'EPROTONOSUPPORT',
+  EPROTOTYPE = 'EPROTOTYPE',
+  ERANGE = 'ERANGE',
+  EREMOTEIO = 'EREMOTEIO',
+  EROFS = 'EROFS',
+  ESHUTDOWN = 'ESHUTDOWN',
+  ESOCKTNOSUPPORT = 'ESOCKTNOSUPPORT',
+  ESPIPE = 'ESPIPE',
+  ESRCH = 'ESRCH',
+  ESTALE = 'ESTALE',
+  ETIME = 'ETIME',
+  ETIMEDOUT = 'ETIMEDOUT',
+  ETXTBSY = 'ETXTBSY',
+  EWOULDBLOCK = 'EWOULDBLOCK',
+  EXDEV = 'EXDEV',
+  UNKNOWN = 'UNKNOWN'
+}
+
+export default SystemErrorCode

src/enums/index.ts

@@ -4,3 +4,4 @@
  */
 
 export { default as ErrorCode } from './error-code'
+export { default as SystemErrorCode } from './error-code-system'