@types/papaparse

What is @types/papaparse?

The @types/papaparse package provides TypeScript type definitions for PapaParse, a powerful CSV (Comma Separated Values) parser. These type definitions allow TypeScript developers to use PapaParse in their projects with the benefits of TypeScript's static type checking. PapaParse can parse CSV files directly from files or strings, and it can also convert JSON to CSV. The type definitions cover all these functionalities, ensuring type safety.

What are @types/papaparse's main functionalities?

Parsing CSV from string

This feature allows parsing of CSV data provided as a string. The parse function takes the CSV string and an options object where you can specify callbacks like 'complete' to handle the parsed data.

import * as Papa from 'papaparse';

const csvData = 'name,age\nAlice,25\nBob,30';
Papa.parse(csvData, {
  complete: (results) => {
    console.log('Parsed:', results.data);
  }
});

Converting JSON to CSV

This feature enables the conversion of JSON data into a CSV format. The 'unparse' function takes an array of objects (representing rows of the CSV) and returns a string in CSV format.

import * as Papa from 'papaparse';

const jsonData = [{ name: 'Alice', age: 25 }, { name: 'Bob', age: 30 }];
const csv = Papa.unparse(jsonData);
console.log(csv);

Other packages similar to @types/papaparse

csv-parse

csv-parse is a Node.js library that provides a parser converting CSV text input into arrays or objects. It operates asynchronously and is capable of handling large datasets. Unlike @types/papaparse, csv-parse is built specifically for Node.js environments and does not require separate type definitions for TypeScript support.

fast-csv

fast-csv is another popular CSV parsing and formatting library for Node.js. It supports both stream-based and promise-based APIs for parsing and formatting CSV data. It is similar to PapaParse in functionality but is optimized for speed and efficiency in Node.js environments. Like csv-parse, it also includes built-in TypeScript support.

README

Installation

npm install --save @types/papaparse

Summary

This package contains type definitions for papaparse (https://github.com/mholt/PapaParse).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse.

Additional Details

• Last updated: Fri, 18 Oct 2024 22:37:29 GMT
• Dependencies: @types/node

Credits

These definitions were written by Pedro Flemming, Rain Shen, João Loff, John Reilly, Alberto Restifo, Janne Liuhtonen, Raphaël Barbazza, Piotr Błażejewicz, Emmanuel Gautier, and Opportunity Liu.