Nuns Practicing Misanthropy

    stream-transform
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.4 • Public • Published

    Stream transformation for Node.js and the web

    Build Status NPM NPM

    The stream-transform project is a simple object transformation framework. It is part of the CSV project.

    The Node.js stream.Transform API is implemented for scalability. The callback-based and sync APIs are also available for convenience. It is both easy to use and powerful.

    Documentation

    Main features

    • Extends the native Node.js transform stream API
    • Simplicity with the optional callback and sync API
    • Pipe transformations between readable and writable streams
    • Synchronous versus asynchronous user functions
    • Sequential and parallel execution
    • Accept object, array or JSON as input and output
    • Sequential or user-defined concurrent execution
    • Skip and multiply records
    • Alter or clone input records
    • MIT License

    Usage

    Run npm install csv to install the full csv module or run npm install csv-transform if you are only interested by the CSV stringifier.

    The module is built on the Node.js Stream API. Use the callback and sync APIs for simplicity or the stream based API for scalability.

    Example

    The API is available in multiple flavors. This example illustrates the sync API.

    import { transform } from 'stream-transform/sync';
    import assert from 'assert';
    
    const records = transform([
      [ 'a', 'b', 'c', 'd' ],
      [ '1', '2', '3', '4' ]
    ], function(record){
      record.push(record.shift());
      return record;
    });
    
    assert.deepEqual(records, [
      [ 'b', 'c', 'd', 'a' ],
      [ '2', '3', '4', '1' ]
    ]);

    Development

    Tests are executed with mocha. To install it, simple run npm install followed by npm test. It will install mocha and its dependencies in your project "node_modules" directory and run the test suite. The tests run against the CoffeeScript source files.

    To generate the JavaScript files, run npm run coffee.

    The test suite is run online with Travis. See the Travis definition file to view the tested Node.js version.

    Contributors

    The project is sponsored by Adaltas, an Big Data consulting firm based in Paris, France.

    Install

    npm i stream-transform

    DownloadsWeekly Downloads

    508,052

    Version

    3.0.4

    License

    MIT

    Unpacked Size

    933 kB

    Total Files

    19

    Last publish

    Collaborators

    • david