Skip to content
This repository has been archived by the owner on Jan 2, 2023. It is now read-only.

Latest commit

 

History

History
57 lines (38 loc) · 1.51 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.51 KB

BigPanda Streams Build Status

Simple but useful streams for various use cases

LineInputStream

Transform stream that splits text into lines

Usage:

var LineInputStream = require('bp-streams').LineInputStream;
var stream = new LineInputStream(options);

options:

Name Description Default
delimiter the character to use to split the lines \n
encoding how to encode the lines UTF-8

FilesystemPersistStream

Persists data that goes through the stream to a file and passes the raw data to the next stream

Usage:

var FilesystemPersistStream = require('bp-streams').FilesystemPersistStream;
var stream = new FilesystemPersistStream(options);

options:

Name Description Default
filename the target filename path -

S3PersistStream

Persists data that goes through the stream to a bucket in S3 and passes the raw data to the next stream

Usage:

var S3PersistStream = require('bp-streams').S3PersistStream;
var stream = new S3PersistStream(options);

options:

Name Description Default
filename file name -
path 'filename' will be saved in this path -
bucket bucket name to upload to -