stream.pipeline-shim

stream.pipeline-shim

Polyfill for stream.pipeline in node versions < v10

node v10.0.0 added support for a built-in stream.pipeline: https://github.com/nodejs/node/pull/19828

This package provides the built-in stream.pipeline in node v10.0.0 and later, and a replacement in other environments.

This module requires Node >= 5.

This package implements the es-shim API interface. It works in an ES5-supported environment and complies with the spec.

Installation

npm install stream.pipeline-shim

Additionally for Typescript:

npm install -D @types/node

Usage

Direct

const pipeline = require('stream.pipeline-shim');
// Use `pipeline` just like the built-in method on `stream`

Typescript:

import pipeline from 'stream.pipeline-shim';
// Use `pipeline` just like the built-in method on `stream`

Shim

require('stream.pipeline-shim/shim')();
// `stream.pipeline` is now defined
const stream = require('stream');
// Use `stream.pipeline`

or:

require('stream.pipeline-shim/auto');
// `stream.pipeline` is now defined
const stream = require('stream');
// Use `stream.pipeline`

Typescript:

import finishedShim from 'stream.pipeline-shim/shim';
finishedShim();
// `stream.pipeline` is now defined
import stream from 'stream';
// Use `stream.pipeline`

or:

import 'stream.pipeline-shim/auto';
// `stream.pipeline` is now defined
import stream from 'stream';
// Use `stream.pipeline`

License

Copyright (c) 2018-2019 Piotr Roszatycki [e-mail]

Copyright Node.js contributors. All rights reserved.

Copyright (c) 2014 Mathias Buus

MIT

Changelog

v1.1.0 2019-05-08

• Typings for Typescript.