1st version

2025-11-04 07:36:02 +00:00
commit 2723c34a5d
177 changed files with 53167 additions and 0 deletions
@@ -0,0 +1,507 @@
+// Original definitions in https://github.com/DefinitelyTyped/DefinitelyTyped by: David Muller <https://github.com/davidm77>
+
+/// <reference types="node" />
+
+import * as stream from "stream";
+
+export type Callback<T = string[]> = (
+  err: CsvError | undefined,
+  records: T[],
+  info?: Info,
+) => void;
+
+// export interface Parser extends stream.Transform {}
+
+// export class Parser<T> extends stream.Transform {
+export class Parser extends stream.Transform {
+  constructor(options: Options);
+
+  // __push(line: T): CsvError | undefined;
+  __push(line: any): CsvError | undefined;
+
+  // __write(chars: any, end: any, callback: any): any;
+
+  readonly options: OptionsNormalized;
+
+  readonly info: Info;
+}
+
+export interface Info {
+  /**
+   * Count the number of lines being fully commented.
+   */
+  readonly comment_lines: number;
+  /**
+   * Count the number of processed empty lines.
+   */
+  readonly empty_lines: number;
+  /**
+   * The number of lines encountered in the source dataset, start at 1 for the first line.
+   */
+  readonly lines: number;
+  /**
+   * Count the number of processed records.
+   */
+  readonly records: number;
+  /**
+   * Count of the number of processed bytes.
+   */
+  readonly bytes: number;
+  /**
+   * Number of non uniform records when `relax_column_count` is true.
+   */
+  readonly invalid_field_length: number;
+  /**
+   * Normalized verion of `options.columns` when `options.columns` is true, boolean otherwise.
+   */
+  readonly columns: boolean | { name: string }[] | { disabled: true }[];
+}
+
+export interface CastingContext {
+  readonly column: number | string;
+  readonly empty_lines: number;
+  readonly error: CsvError;
+  readonly header: boolean;
+  readonly index: number;
+  readonly quoting: boolean;
+  readonly lines: number;
+  readonly raw: string | undefined;
+  readonly records: number;
+  readonly invalid_field_length: number;
+}
+
+export type CastingFunction = (
+  value: string,
+  context: CastingContext,
+) => unknown;
+
+export type CastingDateFunction = (
+  value: string,
+  context: CastingContext,
+) => Date;
+
+export type ColumnOption<K = string> =
+  | K
+  | undefined
+  | null
+  | false
+  | { name: K };
+
+export interface OptionsNormalized<T = string[]> {
+  auto_parse?: boolean | CastingFunction;
+  auto_parse_date?: boolean | CastingDateFunction;
+  /**
+   * If true, detect and exclude the byte order mark (BOM) from the CSV input if present.
+   */
+  bom?: boolean;
+  /**
+   * If true, the parser will attempt to convert input string to native types.
+   * If a function, receive the value as first argument, a context as second argument and return a new value. More information about the context properties is available below.
+   */
+  cast?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert input string to dates.
+   * If a function, receive the value as argument and return a new value. It requires the "auto_parse" option. Be careful, it relies on Date.parse.
+   */
+  cast_date?: boolean | CastingDateFunction;
+  /**
+   * Internal property string the function to
+   */
+  cast_first_line_to_header?: (
+    record: T,
+  ) => ColumnOption<
+    T extends string[] ? string : T extends unknown ? string : keyof T
+  >[];
+  /**
+   * List of fields as an array, a user defined callback accepting the first
+   * line and returning the column names or true if autodiscovered in the first
+   * CSV line, default to null, affect the result data set in the sense that
+   * records will be objects instead of arrays.
+   */
+  columns:
+    | boolean
+    | ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[];
+  /**
+   * Convert values into an array of values when columns are activated and
+   * when multiple columns of the same name are found.
+   */
+  group_columns_by_name: boolean;
+  /**
+   * Treat all the characters after this one as a comment, default to '' (disabled).
+   */
+  comment: string | null;
+  /**
+   * Restrict the definition of comments to a full line. Comment characters
+   * defined in the middle of the line are not interpreted as such. The
+   * option require the activation of comments.
+   */
+  comment_no_infix: boolean;
+  /**
+   * Set the field delimiter. One character only, defaults to comma.
+   */
+  delimiter: Buffer[];
+  /**
+   * Set the source and destination encoding, a value of `null` returns buffer instead of strings.
+   */
+  encoding: BufferEncoding | null;
+  /**
+   * Set the escape character, one character only, defaults to double quotes.
+   */
+  escape: null | Buffer;
+  /**
+   * Start handling records from the requested number of records.
+   */
+  from: number;
+  /**
+   * Start handling records from the requested line number.
+   */
+  from_line: number;
+  /**
+   * Don't interpret delimiters as such in the last field according to the number of fields calculated from the number of columns, the option require the presence of the `column` option when `true`.
+   */
+  ignore_last_delimiters: boolean | number;
+  /**
+   * Generate two properties `info` and `record` where `info` is a snapshot of the info object at the time the record was created and `record` is the parsed array or object.
+   */
+  info: boolean;
+  /**
+   * If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  ltrim: boolean;
+  /**
+   * Maximum numer of characters to be contained in the field and line buffers before an exception is raised,
+   * used to guard against a wrong delimiter or record_delimiter,
+   * default to 128000 characters.
+   */
+  max_record_size: number;
+  /**
+   * Name of header-record title to name objects by.
+   */
+  objname: number | string | undefined;
+  /**
+   * Alter and filter records by executing a user defined function.
+   */
+  on_record?: (record: T, context: CastingContext) => T | undefined;
+  /**
+   * Optional character surrounding a field, one character only, defaults to double quotes.
+   */
+  quote?: Buffer | null;
+  /**
+   * Generate two properties raw and row where raw is the original CSV row content and row is the parsed array or object.
+   */
+  raw: boolean;
+  /**
+   * Discard inconsistent columns count, default to false.
+   */
+  relax_column_count: boolean;
+  /**
+   * Discard inconsistent columns count when the record contains less fields than expected, default to false.
+   */
+  relax_column_count_less: boolean;
+  /**
+   * Discard inconsistent columns count when the record contains more fields than expected, default to false.
+   */
+  relax_column_count_more: boolean;
+  /**
+   * Preserve quotes inside unquoted field.
+   */
+  relax_quotes: boolean;
+  /**
+   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
+   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
+   */
+  record_delimiter: Buffer[];
+  /**
+   * If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  rtrim: boolean;
+  /**
+   * Dont generate empty values for empty lines.
+   * Defaults to false
+   */
+  skip_empty_lines: boolean;
+  /**
+   * Skip a line with error found inside and directly go process the next line.
+   */
+  skip_records_with_error: boolean;
+  /**
+   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
+   */
+  skip_records_with_empty_values: boolean;
+  /**
+   * Stop handling records after the requested number of records.
+   */
+  to: number;
+  /**
+   * Stop handling records after the requested line number.
+   */
+  to_line: number;
+  /**
+   * If true, ignore whitespace immediately around the delimiter, defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  trim: boolean;
+}
+
+/*
+Note, could not `extends stream.TransformOptions` because encoding can be
+BufferEncoding and undefined as well as null which is not defined in the
+extended type.
+*/
+export interface Options<T = string[]> {
+  /**
+   * If true, the parser will attempt to convert read data types to native types.
+   * @deprecated Use {@link cast}
+   */
+  auto_parse?: boolean | CastingFunction;
+  autoParse?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert read data types to dates. It requires the "auto_parse" option.
+   * @deprecated Use {@link cast_date}
+   */
+  auto_parse_date?: boolean | CastingDateFunction;
+  autoParseDate?: boolean | CastingDateFunction;
+  /**
+   * If true, detect and exclude the byte order mark (BOM) from the CSV input if present.
+   */
+  bom?: boolean;
+  /**
+   * If true, the parser will attempt to convert input string to native types.
+   * If a function, receive the value as first argument, a context as second argument and return a new value. More information about the context properties is available below.
+   */
+  cast?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert input string to dates.
+   * If a function, receive the value as argument and return a new value. It requires the "auto_parse" option. Be careful, it relies on Date.parse.
+   */
+  cast_date?: boolean | CastingDateFunction;
+  castDate?: boolean | CastingDateFunction;
+  /**
+   * List of fields as an array,
+   * a user defined callback accepting the first line and returning the column names or true if autodiscovered in the first CSV line,
+   * default to null,
+   * affect the result data set in the sense that records will be objects instead of arrays.
+   */
+  columns?:
+    | boolean
+    | ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[]
+    | ((
+        record: T,
+      ) => ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[]);
+  /**
+   * Convert values into an array of values when columns are activated and
+   * when multiple columns of the same name are found.
+   */
+  group_columns_by_name?: boolean;
+  groupColumnsByName?: boolean;
+  /**
+   * Treat all the characters after this one as a comment, default to '' (disabled).
+   */
+  comment?: string | boolean | null;
+  /**
+   * Restrict the definition of comments to a full line. Comment characters
+   * defined in the middle of the line are not interpreted as such. The
+   * option require the activation of comments.
+   */
+  comment_no_infix?: boolean | null;
+  /**
+   * Set the field delimiter. One character only, defaults to comma.
+   */
+  delimiter?: string | string[] | Buffer;
+  /**
+   * Set the source and destination encoding, a value of `null` returns buffer instead of strings.
+   */
+  encoding?: BufferEncoding | boolean | null | undefined;
+  /**
+   * Set the escape character, one character only, defaults to double quotes.
+   */
+  escape?: string | null | boolean | Buffer;
+  /**
+   * Start handling records from the requested number of records.
+   */
+  from?: number | string;
+  /**
+   * Start handling records from the requested line number.
+   */
+  from_line?: null | number | string;
+  fromLine?: null | number | string;
+  /**
+   * Don't interpret delimiters as such in the last field according to the number of fields calculated from the number of columns, the option require the presence of the `column` option when `true`.
+   */
+  ignore_last_delimiters?: boolean | number;
+  /**
+   * Generate two properties `info` and `record` where `info` is a snapshot of the info object at the time the record was created and `record` is the parsed array or object.
+   */
+  info?: boolean;
+  /**
+   * If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  ltrim?: boolean | null;
+  /**
+   * Maximum numer of characters to be contained in the field and line buffers before an exception is raised,
+   * used to guard against a wrong delimiter or record_delimiter,
+   * default to 128000 characters.
+   */
+  max_record_size?: number | null | string;
+  maxRecordSize?: number;
+  /**
+   * Name of header-record title to name objects by.
+   */
+  objname?: Buffer | null | number | string;
+  /**
+   * Alter and filter records by executing a user defined function.
+   */
+  on_record?: (record: T, context: CastingContext) => T | null | undefined;
+  onRecord?: (record: T, context: CastingContext) => T | null | undefined;
+  /**
+   * Function called when an error occured if the `skip_records_with_error`
+   * option is activated.
+   */
+  on_skip?: (err: CsvError | undefined, raw: string | undefined) => undefined;
+  onSkip?: (err: CsvError | undefined, raw: string | undefined) => undefined;
+  /**
+   * Optional character surrounding a field, one character only, defaults to double quotes.
+   */
+  quote?: string | boolean | Buffer | null;
+  /**
+   * Generate two properties raw and row where raw is the original CSV row content and row is the parsed array or object.
+   */
+  raw?: boolean | null;
+  /**
+   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
+   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
+   */
+  record_delimiter?: string | Buffer | null | (string | Buffer | null)[];
+  recordDelimiter?: string | Buffer | null | (string | Buffer | null)[];
+  /**
+   * Discard inconsistent columns count, default to false.
+   */
+  relax_column_count?: boolean | null;
+  relaxColumnCount?: boolean | null;
+  /**
+   * Discard inconsistent columns count when the record contains less fields than expected, default to false.
+   */
+  relax_column_count_less?: boolean | null;
+  relaxColumnCountLess?: boolean | null;
+  /**
+   * Discard inconsistent columns count when the record contains more fields than expected, default to false.
+   */
+  relax_column_count_more?: boolean | null;
+  relaxColumnCountMore?: boolean | null;
+  /**
+   * Preserve quotes inside unquoted field.
+   */
+  relax_quotes?: boolean | null;
+  relaxQuotes?: boolean | null;
+  /**
+   * If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  rtrim?: boolean | null;
+  /**
+   * Dont generate empty values for empty lines.
+   * Defaults to false
+   */
+  skip_empty_lines?: boolean | null;
+  skipEmptyLines?: boolean | null;
+  /**
+   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
+   */
+  skip_records_with_empty_values?: boolean | null;
+  skipRecordsWithEmptyValues?: boolean | null;
+  /**
+   * Skip a line with error found inside and directly go process the next line.
+   */
+  skip_records_with_error?: boolean | null;
+  skipRecordsWithError?: boolean | null;
+  /**
+   * Stop handling records after the requested number of records.
+   */
+  to?: null | number | string;
+  /**
+   * Stop handling records after the requested line number.
+   */
+  to_line?: null | number | string;
+  toLine?: null | number | string;
+  /**
+   * If true, ignore whitespace immediately around the delimiter, defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  trim?: boolean | null;
+}
+
+export type CsvErrorCode =
+  | "CSV_INVALID_ARGUMENT"
+  | "CSV_INVALID_CLOSING_QUOTE"
+  | "CSV_INVALID_COLUMN_DEFINITION"
+  | "CSV_INVALID_COLUMN_MAPPING"
+  | "CSV_INVALID_OPTION_BOM"
+  | "CSV_INVALID_OPTION_CAST"
+  | "CSV_INVALID_OPTION_CAST_DATE"
+  | "CSV_INVALID_OPTION_COLUMNS"
+  | "CSV_INVALID_OPTION_COMMENT"
+  | "CSV_INVALID_OPTION_DELIMITER"
+  | "CSV_INVALID_OPTION_GROUP_COLUMNS_BY_NAME"
+  | "CSV_INVALID_OPTION_ON_RECORD"
+  | "CSV_MAX_RECORD_SIZE"
+  | "CSV_NON_TRIMABLE_CHAR_AFTER_CLOSING_QUOTE"
+  | "CSV_OPTION_COLUMNS_MISSING_NAME"
+  | "CSV_QUOTE_NOT_CLOSED"
+  | "CSV_RECORD_INCONSISTENT_FIELDS_LENGTH"
+  | "CSV_RECORD_INCONSISTENT_COLUMNS"
+  | "CSV_UNKNOWN_ERROR"
+  | "INVALID_OPENING_QUOTE";
+
+export class CsvError extends Error {
+  readonly code: CsvErrorCode;
+  [key: string]: any;
+
+  constructor(
+    code: CsvErrorCode,
+    message: string | string[],
+    options?: OptionsNormalized,
+    ...contexts: unknown[]
+  );
+}
+
+type OptionsWithColumns<T> = Omit<Options<T>, "columns"> & {
+  columns: Exclude<Options["columns"], undefined | false>;
+};
+
+declare function parse<T = unknown>(
+  input: string | Buffer | Uint8Array,
+  options: OptionsWithColumns<T>,
+  callback?: Callback<T>,
+): Parser;
+declare function parse(
+  input: string | Buffer | Uint8Array,
+  options: Options,
+  callback?: Callback,
+): Parser;
+
+declare function parse<T = unknown>(
+  options: OptionsWithColumns<T>,
+  callback?: Callback<T>,
+): Parser;
+declare function parse(options: Options, callback?: Callback): Parser;
+
+declare function parse(
+  input: string | Buffer | Uint8Array,
+  callback?: Callback,
+): Parser;
+declare function parse(callback?: Callback): Parser;
+
+// export default parse;
+export { parse };
+
+declare function normalize_options(opts: Options): OptionsNormalized;
+export { normalize_options };
@@ -0,0 +1,30 @@
+import { Options } from "./index.cjs";
+
+type OptionsWithColumns<T> = Omit<Options<T>, "columns"> & {
+  columns: Exclude<Options["columns"], undefined | false>;
+};
+
+declare function parse<T = unknown>(
+  input: Buffer | string | Uint8Array,
+  options: OptionsWithColumns<T>,
+): T[];
+declare function parse(
+  input: Buffer | string | Uint8Array,
+  options: Options,
+): string[][];
+declare function parse(input: Buffer | string | Uint8Array): string[][];
+
+// export default parse;
+export { parse };
+
+export {
+  CastingContext,
+  CastingFunction,
+  CastingDateFunction,
+  ColumnOption,
+  Options,
+  OptionsNormalized,
+  Info,
+  CsvErrorCode,
+  CsvError,
+} from "./index.cjs";
@@ -0,0 +1,507 @@
+// Original definitions in https://github.com/DefinitelyTyped/DefinitelyTyped by: David Muller <https://github.com/davidm77>
+
+/// <reference types="node" />
+
+import * as stream from "stream";
+
+export type Callback<T = string[]> = (
+  err: CsvError | undefined,
+  records: T[],
+  info?: Info,
+) => void;
+
+// export interface Parser extends stream.Transform {}
+
+// export class Parser<T> extends stream.Transform {
+export class Parser extends stream.Transform {
+  constructor(options: Options);
+
+  // __push(line: T): CsvError | undefined;
+  __push(line: any): CsvError | undefined;
+
+  // __write(chars: any, end: any, callback: any): any;
+
+  readonly options: OptionsNormalized;
+
+  readonly info: Info;
+}
+
+export interface Info {
+  /**
+   * Count the number of lines being fully commented.
+   */
+  readonly comment_lines: number;
+  /**
+   * Count the number of processed empty lines.
+   */
+  readonly empty_lines: number;
+  /**
+   * The number of lines encountered in the source dataset, start at 1 for the first line.
+   */
+  readonly lines: number;
+  /**
+   * Count the number of processed records.
+   */
+  readonly records: number;
+  /**
+   * Count of the number of processed bytes.
+   */
+  readonly bytes: number;
+  /**
+   * Number of non uniform records when `relax_column_count` is true.
+   */
+  readonly invalid_field_length: number;
+  /**
+   * Normalized verion of `options.columns` when `options.columns` is true, boolean otherwise.
+   */
+  readonly columns: boolean | { name: string }[] | { disabled: true }[];
+}
+
+export interface CastingContext {
+  readonly column: number | string;
+  readonly empty_lines: number;
+  readonly error: CsvError;
+  readonly header: boolean;
+  readonly index: number;
+  readonly quoting: boolean;
+  readonly lines: number;
+  readonly raw: string | undefined;
+  readonly records: number;
+  readonly invalid_field_length: number;
+}
+
+export type CastingFunction = (
+  value: string,
+  context: CastingContext,
+) => unknown;
+
+export type CastingDateFunction = (
+  value: string,
+  context: CastingContext,
+) => Date;
+
+export type ColumnOption<K = string> =
+  | K
+  | undefined
+  | null
+  | false
+  | { name: K };
+
+export interface OptionsNormalized<T = string[]> {
+  auto_parse?: boolean | CastingFunction;
+  auto_parse_date?: boolean | CastingDateFunction;
+  /**
+   * If true, detect and exclude the byte order mark (BOM) from the CSV input if present.
+   */
+  bom?: boolean;
+  /**
+   * If true, the parser will attempt to convert input string to native types.
+   * If a function, receive the value as first argument, a context as second argument and return a new value. More information about the context properties is available below.
+   */
+  cast?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert input string to dates.
+   * If a function, receive the value as argument and return a new value. It requires the "auto_parse" option. Be careful, it relies on Date.parse.
+   */
+  cast_date?: boolean | CastingDateFunction;
+  /**
+   * Internal property string the function to
+   */
+  cast_first_line_to_header?: (
+    record: T,
+  ) => ColumnOption<
+    T extends string[] ? string : T extends unknown ? string : keyof T
+  >[];
+  /**
+   * List of fields as an array, a user defined callback accepting the first
+   * line and returning the column names or true if autodiscovered in the first
+   * CSV line, default to null, affect the result data set in the sense that
+   * records will be objects instead of arrays.
+   */
+  columns:
+    | boolean
+    | ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[];
+  /**
+   * Convert values into an array of values when columns are activated and
+   * when multiple columns of the same name are found.
+   */
+  group_columns_by_name: boolean;
+  /**
+   * Treat all the characters after this one as a comment, default to '' (disabled).
+   */
+  comment: string | null;
+  /**
+   * Restrict the definition of comments to a full line. Comment characters
+   * defined in the middle of the line are not interpreted as such. The
+   * option require the activation of comments.
+   */
+  comment_no_infix: boolean;
+  /**
+   * Set the field delimiter. One character only, defaults to comma.
+   */
+  delimiter: Buffer[];
+  /**
+   * Set the source and destination encoding, a value of `null` returns buffer instead of strings.
+   */
+  encoding: BufferEncoding | null;
+  /**
+   * Set the escape character, one character only, defaults to double quotes.
+   */
+  escape: null | Buffer;
+  /**
+   * Start handling records from the requested number of records.
+   */
+  from: number;
+  /**
+   * Start handling records from the requested line number.
+   */
+  from_line: number;
+  /**
+   * Don't interpret delimiters as such in the last field according to the number of fields calculated from the number of columns, the option require the presence of the `column` option when `true`.
+   */
+  ignore_last_delimiters: boolean | number;
+  /**
+   * Generate two properties `info` and `record` where `info` is a snapshot of the info object at the time the record was created and `record` is the parsed array or object.
+   */
+  info: boolean;
+  /**
+   * If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  ltrim: boolean;
+  /**
+   * Maximum numer of characters to be contained in the field and line buffers before an exception is raised,
+   * used to guard against a wrong delimiter or record_delimiter,
+   * default to 128000 characters.
+   */
+  max_record_size: number;
+  /**
+   * Name of header-record title to name objects by.
+   */
+  objname: number | string | undefined;
+  /**
+   * Alter and filter records by executing a user defined function.
+   */
+  on_record?: (record: T, context: CastingContext) => T | undefined;
+  /**
+   * Optional character surrounding a field, one character only, defaults to double quotes.
+   */
+  quote?: Buffer | null;
+  /**
+   * Generate two properties raw and row where raw is the original CSV row content and row is the parsed array or object.
+   */
+  raw: boolean;
+  /**
+   * Discard inconsistent columns count, default to false.
+   */
+  relax_column_count: boolean;
+  /**
+   * Discard inconsistent columns count when the record contains less fields than expected, default to false.
+   */
+  relax_column_count_less: boolean;
+  /**
+   * Discard inconsistent columns count when the record contains more fields than expected, default to false.
+   */
+  relax_column_count_more: boolean;
+  /**
+   * Preserve quotes inside unquoted field.
+   */
+  relax_quotes: boolean;
+  /**
+   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
+   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
+   */
+  record_delimiter: Buffer[];
+  /**
+   * If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  rtrim: boolean;
+  /**
+   * Dont generate empty values for empty lines.
+   * Defaults to false
+   */
+  skip_empty_lines: boolean;
+  /**
+   * Skip a line with error found inside and directly go process the next line.
+   */
+  skip_records_with_error: boolean;
+  /**
+   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
+   */
+  skip_records_with_empty_values: boolean;
+  /**
+   * Stop handling records after the requested number of records.
+   */
+  to: number;
+  /**
+   * Stop handling records after the requested line number.
+   */
+  to_line: number;
+  /**
+   * If true, ignore whitespace immediately around the delimiter, defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  trim: boolean;
+}
+
+/*
+Note, could not `extends stream.TransformOptions` because encoding can be
+BufferEncoding and undefined as well as null which is not defined in the
+extended type.
+*/
+export interface Options<T = string[]> {
+  /**
+   * If true, the parser will attempt to convert read data types to native types.
+   * @deprecated Use {@link cast}
+   */
+  auto_parse?: boolean | CastingFunction;
+  autoParse?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert read data types to dates. It requires the "auto_parse" option.
+   * @deprecated Use {@link cast_date}
+   */
+  auto_parse_date?: boolean | CastingDateFunction;
+  autoParseDate?: boolean | CastingDateFunction;
+  /**
+   * If true, detect and exclude the byte order mark (BOM) from the CSV input if present.
+   */
+  bom?: boolean;
+  /**
+   * If true, the parser will attempt to convert input string to native types.
+   * If a function, receive the value as first argument, a context as second argument and return a new value. More information about the context properties is available below.
+   */
+  cast?: boolean | CastingFunction;
+  /**
+   * If true, the parser will attempt to convert input string to dates.
+   * If a function, receive the value as argument and return a new value. It requires the "auto_parse" option. Be careful, it relies on Date.parse.
+   */
+  cast_date?: boolean | CastingDateFunction;
+  castDate?: boolean | CastingDateFunction;
+  /**
+   * List of fields as an array,
+   * a user defined callback accepting the first line and returning the column names or true if autodiscovered in the first CSV line,
+   * default to null,
+   * affect the result data set in the sense that records will be objects instead of arrays.
+   */
+  columns?:
+    | boolean
+    | ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[]
+    | ((
+        record: T,
+      ) => ColumnOption<
+        T extends string[] ? string : T extends unknown ? string : keyof T
+      >[]);
+  /**
+   * Convert values into an array of values when columns are activated and
+   * when multiple columns of the same name are found.
+   */
+  group_columns_by_name?: boolean;
+  groupColumnsByName?: boolean;
+  /**
+   * Treat all the characters after this one as a comment, default to '' (disabled).
+   */
+  comment?: string | boolean | null;
+  /**
+   * Restrict the definition of comments to a full line. Comment characters
+   * defined in the middle of the line are not interpreted as such. The
+   * option require the activation of comments.
+   */
+  comment_no_infix?: boolean | null;
+  /**
+   * Set the field delimiter. One character only, defaults to comma.
+   */
+  delimiter?: string | string[] | Buffer;
+  /**
+   * Set the source and destination encoding, a value of `null` returns buffer instead of strings.
+   */
+  encoding?: BufferEncoding | boolean | null | undefined;
+  /**
+   * Set the escape character, one character only, defaults to double quotes.
+   */
+  escape?: string | null | boolean | Buffer;
+  /**
+   * Start handling records from the requested number of records.
+   */
+  from?: number | string;
+  /**
+   * Start handling records from the requested line number.
+   */
+  from_line?: null | number | string;
+  fromLine?: null | number | string;
+  /**
+   * Don't interpret delimiters as such in the last field according to the number of fields calculated from the number of columns, the option require the presence of the `column` option when `true`.
+   */
+  ignore_last_delimiters?: boolean | number;
+  /**
+   * Generate two properties `info` and `record` where `info` is a snapshot of the info object at the time the record was created and `record` is the parsed array or object.
+   */
+  info?: boolean;
+  /**
+   * If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  ltrim?: boolean | null;
+  /**
+   * Maximum numer of characters to be contained in the field and line buffers before an exception is raised,
+   * used to guard against a wrong delimiter or record_delimiter,
+   * default to 128000 characters.
+   */
+  max_record_size?: number | null | string;
+  maxRecordSize?: number;
+  /**
+   * Name of header-record title to name objects by.
+   */
+  objname?: Buffer | null | number | string;
+  /**
+   * Alter and filter records by executing a user defined function.
+   */
+  on_record?: (record: T, context: CastingContext) => T | null | undefined;
+  onRecord?: (record: T, context: CastingContext) => T | null | undefined;
+  /**
+   * Function called when an error occured if the `skip_records_with_error`
+   * option is activated.
+   */
+  on_skip?: (err: CsvError | undefined, raw: string | undefined) => undefined;
+  onSkip?: (err: CsvError | undefined, raw: string | undefined) => undefined;
+  /**
+   * Optional character surrounding a field, one character only, defaults to double quotes.
+   */
+  quote?: string | boolean | Buffer | null;
+  /**
+   * Generate two properties raw and row where raw is the original CSV row content and row is the parsed array or object.
+   */
+  raw?: boolean | null;
+  /**
+   * One or multiple characters used to delimit record rows; defaults to auto discovery if not provided.
+   * Supported auto discovery method are Linux ("\n"), Apple ("\r") and Windows ("\r\n") row delimiters.
+   */
+  record_delimiter?: string | Buffer | null | (string | Buffer | null)[];
+  recordDelimiter?: string | Buffer | null | (string | Buffer | null)[];
+  /**
+   * Discard inconsistent columns count, default to false.
+   */
+  relax_column_count?: boolean | null;
+  relaxColumnCount?: boolean | null;
+  /**
+   * Discard inconsistent columns count when the record contains less fields than expected, default to false.
+   */
+  relax_column_count_less?: boolean | null;
+  relaxColumnCountLess?: boolean | null;
+  /**
+   * Discard inconsistent columns count when the record contains more fields than expected, default to false.
+   */
+  relax_column_count_more?: boolean | null;
+  relaxColumnCountMore?: boolean | null;
+  /**
+   * Preserve quotes inside unquoted field.
+   */
+  relax_quotes?: boolean | null;
+  relaxQuotes?: boolean | null;
+  /**
+   * If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  rtrim?: boolean | null;
+  /**
+   * Dont generate empty values for empty lines.
+   * Defaults to false
+   */
+  skip_empty_lines?: boolean | null;
+  skipEmptyLines?: boolean | null;
+  /**
+   * Don't generate records for lines containing empty column values (column matching /\s*\/), defaults to false.
+   */
+  skip_records_with_empty_values?: boolean | null;
+  skipRecordsWithEmptyValues?: boolean | null;
+  /**
+   * Skip a line with error found inside and directly go process the next line.
+   */
+  skip_records_with_error?: boolean | null;
+  skipRecordsWithError?: boolean | null;
+  /**
+   * Stop handling records after the requested number of records.
+   */
+  to?: null | number | string;
+  /**
+   * Stop handling records after the requested line number.
+   */
+  to_line?: null | number | string;
+  toLine?: null | number | string;
+  /**
+   * If true, ignore whitespace immediately around the delimiter, defaults to false.
+   * Does not remove whitespace in a quoted field.
+   */
+  trim?: boolean | null;
+}
+
+export type CsvErrorCode =
+  | "CSV_INVALID_ARGUMENT"
+  | "CSV_INVALID_CLOSING_QUOTE"
+  | "CSV_INVALID_COLUMN_DEFINITION"
+  | "CSV_INVALID_COLUMN_MAPPING"
+  | "CSV_INVALID_OPTION_BOM"
+  | "CSV_INVALID_OPTION_CAST"
+  | "CSV_INVALID_OPTION_CAST_DATE"
+  | "CSV_INVALID_OPTION_COLUMNS"
+  | "CSV_INVALID_OPTION_COMMENT"
+  | "CSV_INVALID_OPTION_DELIMITER"
+  | "CSV_INVALID_OPTION_GROUP_COLUMNS_BY_NAME"
+  | "CSV_INVALID_OPTION_ON_RECORD"
+  | "CSV_MAX_RECORD_SIZE"
+  | "CSV_NON_TRIMABLE_CHAR_AFTER_CLOSING_QUOTE"
+  | "CSV_OPTION_COLUMNS_MISSING_NAME"
+  | "CSV_QUOTE_NOT_CLOSED"
+  | "CSV_RECORD_INCONSISTENT_FIELDS_LENGTH"
+  | "CSV_RECORD_INCONSISTENT_COLUMNS"
+  | "CSV_UNKNOWN_ERROR"
+  | "INVALID_OPENING_QUOTE";
+
+export class CsvError extends Error {
+  readonly code: CsvErrorCode;
+  [key: string]: any;
+
+  constructor(
+    code: CsvErrorCode,
+    message: string | string[],
+    options?: OptionsNormalized,
+    ...contexts: unknown[]
+  );
+}
+
+type OptionsWithColumns<T> = Omit<Options<T>, "columns"> & {
+  columns: Exclude<Options["columns"], undefined | false>;
+};
+
+declare function parse<T = unknown>(
+  input: string | Buffer | Uint8Array,
+  options: OptionsWithColumns<T>,
+  callback?: Callback<T>,
+): Parser;
+declare function parse(
+  input: string | Buffer | Uint8Array,
+  options: Options,
+  callback?: Callback,
+): Parser;
+
+declare function parse<T = unknown>(
+  options: OptionsWithColumns<T>,
+  callback?: Callback<T>,
+): Parser;
+declare function parse(options: Options, callback?: Callback): Parser;
+
+declare function parse(
+  input: string | Buffer | Uint8Array,
+  callback?: Callback,
+): Parser;
+declare function parse(callback?: Callback): Parser;
+
+// export default parse;
+export { parse };
+
+declare function normalize_options(opts: Options): OptionsNormalized;
+export { normalize_options };
@@ -0,0 +1,17 @@
+import { Options } from "./index.js";
+
+declare function parse(options?: Options): TransformStream;
+// export default parse;
+export { parse };
+
+export {
+  CastingContext,
+  CastingFunction,
+  CastingDateFunction,
+  ColumnOption,
+  Options,
+  OptionsNormalized,
+  Info,
+  CsvErrorCode,
+  CsvError,
+} from "./index.js";
@@ -0,0 +1,30 @@
+import { Options } from "./index.js";
+
+type OptionsWithColumns<T> = Omit<Options<T>, "columns"> & {
+  columns: Exclude<Options["columns"], undefined | false>;
+};
+
+declare function parse<T = unknown>(
+  input: Buffer | string | Uint8Array,
+  options: OptionsWithColumns<T>,
+): T[];
+declare function parse(
+  input: Buffer | string | Uint8Array,
+  options: Options,
+): string[][];
+declare function parse(input: Buffer | string | Uint8Array): string[][];
+
+// export default parse;
+export { parse };
+
+export {
+  CastingContext,
+  CastingFunction,
+  CastingDateFunction,
+  ColumnOption,
+  Options,
+  OptionsNormalized,
+  Info,
+  CsvErrorCode,
+  CsvError,
+} from "./index.js";