Interface Options

packages/csv-parse/lib/index.d.ts:276–476

extended type.
*/
export interface Options<T = string[], U = T> {
  /**
   * 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?: OptionsNormalized["bom"];
  /**
   * 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?: OptionsNormalized["cast"];
  /**
   * 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?: OptionsNormalized["cast_date"];
  castDate?: OptionsNormalized["cast_date"];
  /**
   * 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?:
    | OptionsNormalized["columns"]
    | ((
        record: T,
      ) => ColumnOption<
        T extends string[] ? string : T extends unknown ? string : keyof T
      >[]);
  /**
   * Treat all the characters after this one as a comment, default to '' (disabled).
   */
  comment?: OptionsNormalized["comment"] | boolean;
  /**
   * 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?: OptionsNormalized["comment_no_infix"] | null;
  /**
   * Set the field delimiter. One character only, defaults to comma.
   */
  delimiter?: OptionsNormalized["delimiter"] | string | string[] | Buffer;
  /**
   * Discover the field delimiter
   */