Class CsvPowers

Static parse

• parse<T>(data: Buffer, options?: CsvParseOptions): Promise<T[]>

• Parses buffer data using CsvParseOptions to create an array of type T.

  throws

  {TypeError} When data is missing.

  throws

  {Error} When invalid CsvParseOptions are passed in.

  throws

  {Error} When the csv file cannot be parsed with the default or provided options.

  example

  In this example, data is pulled from a csv file and parsed into array of Data Rows.

  // Ensure you have imported the CsvPowers
  // import { CsvPowers, CsvParseOptions, DataPowers } from "@andi/powers";
  
  type DataRow = { column1: string, column2: string };
  const rawData = await DataPowers.get("example.csv", { type: DataType.File, parseOptions: "buffer" });
  const exampleData = await CsvPowers.parse<DataRow>(rawData);
  
  // Recommended: if manual parsing is not needed, you can combine load and parse
  const orgData: DataRow[] = await DataPowers.get<DataRow>("example.csv", { type: DataType.File, parseOptions: "csv" });
  
  // Alternative: with custom csv options
  const orgData: DataRow[] = await DataPowers.get<DataRow>("example.csv", { type: DataType.File, parseOptions: { cast: true, skip_lines_with_error: true} as CsvParseOptions });

  Type parameters

  • T = unknown

  Parameters

  • data: Buffer

    Buffer with CSV data.

  • Optional options: CsvParseOptions

    Various options to control how your CSV is parsed. By default, CSV rows will be parsed into objects.

  Returns Promise<T[]>