type newline result meta field as Newline, and export Newline type (#19)

Author: severo

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## [0.0.5]
+
+- export Newline type
+
 ## [0.0.4]
 
 - export parse result types

package.json

@@ -1,6 +1,6 @@
 {
   "name": "csv-range",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Parse ranges of a CSV file.",
   "type": "module",
   "license": "MIT",

src/index.ts

@@ -1,4 +1,4 @@
 export { parseText } from './text'
-export type { ParseError, ParseMeta, ParseResult } from './types'
+export type { Newline, ParseError, ParseMeta, ParseResult } from './types'
 export { parseURL } from './url'
 export { testEmptyLine } from './utils'

src/options/delimiter.ts

@@ -1,7 +1,7 @@
 import { parse } from '../parser'
+import type { Newline } from '../types'
 import { testEmptyLine } from '../utils'
 import { BAD_DELIMITERS, RECORD_SEP, UNIT_SEP } from './constants'
-import type { Newline } from './newline'
 
 /**
  * Validates the delimiter

src/options/newline.ts

@@ -1,7 +1,6 @@
+import type { Newline } from '../types'
 import { escapeRegExp } from '../utils'
 
-export type Newline = '\n' | '\r' | '\r\n'
-
 /**
  * Returns the newline string to be used in parsing.
  * @param newline The newline string to validate.

src/options/parseOptions.ts

@@ -1,8 +1,9 @@
+import type { Newline } from '../types'
 import { validateComments } from './comments'
 import { DefaultDelimiter } from './constants'
 import { guessDelimiter, validateDelimiter } from './delimiter'
 import { validateEscapeChar } from './escapeChar'
-import { guessLineEndings, type Newline, validateNewline } from './newline'
+import { guessLineEndings, validateNewline } from './newline'
 import { validateQuoteChar } from './quoteChar'
 
 export interface ParseOptions {

src/types.d.ts

@@ -1,3 +1,5 @@
+export type Newline = '\n' | '\r' | '\r\n'
+
 /** Error structure */
 export interface ParseError {
   /** A generalization of the error */
@@ -18,7 +20,7 @@ export interface ParseMeta {
   /** Delimiter used */
   delimiter: string
   /** Line break sequence used */
-  newline: string
+  newline: Newline
   /** Byte offset at the start of the row */
   byteOffset: number
   /** Number of bytes consumed in this row */

tests/parser.test.ts

@@ -17,7 +17,7 @@ describe('Papaparse core parser tests', () => {
         expect(charCount).toBe(test.expected.meta?.charCount)
       }
       if (test.expected.meta?.newline !== undefined) {
-        const newlines = new Set(result.map(({ meta }) => meta.newline))
+        const newlines = new Set<string>(result.map(({ meta }) => meta.newline as string))
         expect(newlines.size).toBe(1)
         expect(newlines.has(test.expected.meta?.newline)).toBe(true)
       }

tests/text.test.ts

@@ -70,7 +70,7 @@ describe('Papaparse high-level tests', () => {
         expect(charCount).toBe(test.expected.meta?.charCount)
       }
       if (test.expected.meta?.newline !== undefined) {
-        const newlines = new Set(result.map(({ meta }) => meta.newline))
+        const newlines = new Set(result.map(({ meta }) => meta.newline as string))
         expect(newlines.size).toBe(1)
         expect(newlines.has(test.expected.meta?.newline)).toBe(true)
       }

tests/url.test.ts

@@ -110,7 +110,7 @@ describe('parseURL, while mocking parse, ', () => {
           byteOffset: 0,
           byteCount: 2 * text.length,
           charCount: 2 * text.length,
-          newline: '\n',
+          newline: '\n' as const,
           // quote: '"',
           delimiter: ',',
         },
@@ -150,7 +150,7 @@ describe('Papaparse high-level tests', () => {
         expect(charCount).toBe(test.expected.meta?.charCount)
       }
       if (test.expected.meta?.newline !== undefined) {
-        const newlines = new Set(result.map(({ meta }) => meta.newline))
+        const newlines = new Set(result.map(({ meta }) => meta.newline as string))
         expect(newlines.size).toBe(1)
         expect(newlines.has(test.expected.meta?.newline)).toBe(true)
       }