@datastream/csv v0.0.35

@datastream/csv

Commonly used stream patterns for Web Streams API and NodeJS Streams.

• Dependencies
• Support
• Install
• Streams
  • Format
  • Parse

Dependencies

• csv-rex: CSV parsing and formatting.

Support

Install

npm install @datastream/csv

Streams

Format

• Input: object or array
• Output: string

Options

From the csv-rex documentation:

Examples

Basic

import { pipeline } from '@datastream/core'
import { csvFormatStream } from '@datastream/csv'
// or
import csvFormatStream from '@datastream/csv/format'

const csvFormatStreamOptions = {}
const streams = [
  // Readable stream ...
  csvFormatStream(csvFormatStreamOptions),
  // Writable stream ...
]

await pipeline(...streams)

NodeJS: format and save to file

import { createWriteStream } from 'node:fs'
import { pipeline, createReadableStream, createTransformStream } from '@datastream/core'
import { csvParseStream } from '@datastream/csv'

const streams = [
	createReadableStream([{...},...]),
	createTransformStream(() => {...}),
	csvFormatStream({ header:[...] }),
	createWriteStream('/tmp/output.csv'),
]

await pipeline(...streams)

Parse

• Input: string
• Output: object or array

Options

See csv-rex for options

Examples

Basic

import { pipeline } from '@datastream/core'
import { csvParseStream } from '@datastream/csv'
// or
import csvParseStream from '@datastream/csv/parse'

const csvParseStreamOptions = {}
const streams = [
  // Readable stream ...
  csvParseStream(csvParseStreamOptions),
  // Writable stream ...
]

await pipeline(streams)

NodeJS: Read file and parse

import { createReadStream } from 'node:fs'
import { pipeline, createTransformStream, createWritableStream } from '@datastream/core'
import { csvParseStream } from '@datastream/csv'

const streams = [
	createReadStream('/tmp/input.csv'),
	csvParseStream({...}),
	createTransformStream(() => {...}),
	createWritableStream()
]

await pipeline(streams)

Browser: Read <input type="file"> and parse in a WebWorker

Examples

NodeJS