feat: eol

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

README.md

@@ -80,7 +80,6 @@ In browsers with [`esm.sh`][esmsh]:
 ## Types
 
 This package is fully typed with [TypeScript][].
-It exports no additional types.
 
 ## Project
 

src/__snapshots__/edge-runtime/index.e2e.snap

@@ -2,6 +2,7 @@
 
 exports[`e2e:mark-util-character > should expose public api 1`] = `
 [
+  "eol",
   "eos",
   "htab",
   "is",

src/__snapshots__/happy-dom/index.e2e.snap

@@ -2,6 +2,7 @@
 
 exports[`e2e:mark-util-character > should expose public api 1`] = `
 [
+  "eol",
   "eos",
   "htab",
   "is",

src/__snapshots__/node/index.e2e.snap

@@ -2,6 +2,7 @@
 
 exports[`e2e:mark-util-character > should expose public api 1`] = `
 [
+  "eol",
   "eos",
   "htab",
   "is",

src/__tests__/eol.spec.mts

@@ -0,0 +1,25 @@
+/**
+ * @file Unit Tests - eol
+ * @module mark-util-character/tests/unit/eol
+ */
+
+import { codes } from '@flex-development/mark-util-symbol'
+import testSubject from '../eol.mts'
+
+describe('unit:eol', () => {
+  it('should return `false` if `code` is not line ending code', () => {
+    expect(testSubject(codes.space)).to.be.false
+  })
+
+  it.each<[keyof typeof codes]>([
+    ['cr'],
+    ['crlf'],
+    ['lf'],
+    ['ls'],
+    ['ps'],
+    ['vcr'],
+    ['vlf']
+  ])('should return `true` if `code` is line ending code (`codes.%s`)', key => {
+    expect(testSubject(codes[key])).to.be.true
+  })
+})

src/eol.mts

@@ -0,0 +1,36 @@
+/**
+ * @file eol
+ * @module mark-util-character/eol
+ */
+
+import type { LineEnding } from '@flex-development/mark-util-character'
+import { codes } from '@flex-development/mark-util-symbol'
+
+/**
+ * Check if `code` represents a line ending.
+ *
+ * @see {@linkcode LineEnding}
+ *
+ * @this {void}
+ *
+ * @param {unknown} code
+ *  The character code to check
+ * @return {code is LineEnding}
+ *  `true` if `code` is line ending code, `false` otherwise
+ */
+function eol(this: void, code: unknown): code is LineEnding {
+  switch (code) {
+    case codes.cr:
+    case codes.crlf:
+    case codes.lf:
+    case codes.ls:
+    case codes.ps:
+    case codes.vcr:
+    case codes.vlf:
+      return true
+    default:
+      return false
+  }
+}
+
+export default eol

src/index.mts

@@ -3,7 +3,9 @@
  * @module mark-util-character
  */
 
+export { default as eol } from './eol.mts'
 export { default as eos } from './eos.mts'
 export { default as htab } from './htab.mts'
 export { default as is, default as isCode } from './is.mts'
+export type * from './types/index.mts'
 export { default as vtab } from './vtab.mts'

src/types/__tests__/line-ending.spec-d.mts

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - LineEnding
+ * @module mark-util-character/types/tests/unit-d/LineEnding
+ */
+
+import type { codes } from '@flex-development/mark-util-symbol'
+import type TestSubject from '../line-ending.mts'
+
+describe('unit-d:types/LineEnding', () => {
+  it('should extract typeof codes.cr', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.cr>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.crlf', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.crlf>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.lf', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.lf>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.ls', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.ls>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.ps', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.ps>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.vcr', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.vcr>().not.toBeNever()
+  })
+
+  it('should extract typeof codes.vlf', () => {
+    expectTypeOf<TestSubject>().extract<typeof codes.vlf>().not.toBeNever()
+  })
+})

src/types/index.mts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Type Aliases
+ * @module mark-util-character/types
+ */
+
+export type { default as LineEnding } from './line-ending.mts'

src/types/line-ending.mts

@@ -0,0 +1,28 @@
+/**
+ * @file Type Aliases - LineEnding
+ * @module mark-util-character/types/LineEnding
+ */
+
+import type { codes } from '@flex-development/mark-util-symbol'
+
+/**
+ * Union of codes representing a line ending.
+ *
+ * @see {@linkcode codes.cr}
+ * @see {@linkcode codes.crlf}
+ * @see {@linkcode codes.lf}
+ * @see {@linkcode codes.ls}
+ * @see {@linkcode codes.ps}
+ * @see {@linkcode codes.vcr}
+ * @see {@linkcode codes.vlf}
+ */
+type LineEnding =
+  | typeof codes.cr
+  | typeof codes.crlf
+  | typeof codes.lf
+  | typeof codes.ls
+  | typeof codes.ps
+  | typeof codes.vcr
+  | typeof codes.vlf
+
+export type { LineEnding as default }