@fast-csv/parse

What is @fast-csv/parse?

@fast-csv/parse is a powerful and flexible CSV parsing library for Node.js. It allows you to read and parse CSV files or strings with ease, providing a variety of options to handle different CSV formats and use cases.

What are @fast-csv/parse's main functionalities?

Parsing CSV from a file

This feature allows you to parse a CSV file from the file system. The `headers: true` option indicates that the first row of the CSV file contains headers.

const fs = require('fs');
const { parse } = require('@fast-csv/parse');

fs.createReadStream('path/to/your.csv')
  .pipe(parse({ headers: true }))
  .on('data', row => console.log(row))
  .on('end', rowCount => console.log(`Parsed ${rowCount} rows`));

Parsing CSV from a string

This feature allows you to parse a CSV string directly. The `headers: true` option indicates that the first row of the CSV string contains headers.

const { parseString } = require('@fast-csv/parse');

const csvString = 'header1,header2\nvalue1,value2\nvalue3,value4';

parseString(csvString, { headers: true })
  .on('data', row => console.log(row))
  .on('end', rowCount => console.log(`Parsed ${rowCount} rows`));

Handling different delimiters

This feature allows you to parse CSV data with a custom delimiter. In this example, the delimiter is set to a semicolon (`;`).

const { parseString } = require('@fast-csv/parse');

const csvString = 'header1;header2\nvalue1;value2\nvalue3;value4';

parseString(csvString, { headers: true, delimiter: ';' })
  .on('data', row => console.log(row))
  .on('end', rowCount => console.log(`Parsed ${rowCount} rows`));

Transforming data during parsing

This feature allows you to transform data during parsing. The `transform` function is applied to each row, allowing you to modify the data as it is being parsed.

const { parse } = require('@fast-csv/parse');

const transform = (row) => {
  return {
    ...row,
    transformed: true
  };
};

parse({ headers: true, transform })
  .on('data', row => console.log(row))
  .on('end', rowCount => console.log(`Parsed ${rowCount} rows`));

Other packages similar to @fast-csv/parse

csv-parser

csv-parser is a simple and fast CSV parsing library for Node.js. It is similar to @fast-csv/parse in terms of functionality but is often praised for its simplicity and ease of use. However, it may not offer as many advanced features and customization options as @fast-csv/parse.

papaparse

PapaParse is a powerful CSV parsing library that works in both Node.js and the browser. It offers a wide range of features, including support for large files, web workers, and various parsing options. Compared to @fast-csv/parse, PapaParse is more versatile in terms of environment support but may have a steeper learning curve.

csv-parse

csv-parse is a part of the CSV module suite from the Node.js CSV project. It provides robust CSV parsing capabilities with a focus on performance and flexibility. While it offers similar functionality to @fast-csv/parse, it is part of a larger suite of CSV-related tools, which can be advantageous for more complex CSV handling needs.

README

@fast-csv/parse

fast-csv package to parse CSVs.

Installation

Install Guide

Usage

To get started with @fast-csv/parse check out the docs

Changelog

5.0.2 (2024-10-22)

Bug Fixes

• deps: update docusaurus monorepo to v3.3.2 (#888) (60f5e27)
• deps: update docusaurus monorepo to v3.4.0 (#961) (cef2f2e)