cloudworker-proxy
Version:
An api gateway for cloudflare workers
95 lines (66 loc) • 2.13 kB
Markdown
# stream.pipeline-shim
<!-- markdownlint-disable MD013 -->
[](http://travis-ci.org/dex4er/js-stream.pipeline-shim) [](https://www.npmjs.com/package/stream.pipeline-shim)
<!-- markdownlint-enable MD013 -->
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](https://github.com/es-shims/api)
interface. It works in an ES5-supported environment and complies with the
[spec](http://www.ecma-international.org/ecma-262/6.0/).
## Installation
```shell
npm install stream.pipeline-shim
```
_Additionally for Typescript:_
```shell
npm install -D @types/node
```
## Usage
### Direct
```js
const pipeline = require('stream.pipeline-shim');
// Use `pipeline` just like the built-in method on `stream`
```
_Typescript:_
```ts
import pipeline from 'stream.pipeline-shim';
// Use `pipeline` just like the built-in method on `stream`
```
### Shim
```js
require('stream.pipeline-shim/shim')();
// `stream.pipeline` is now defined
const stream = require('stream');
// Use `stream.pipeline`
```
or:
```js
require('stream.pipeline-shim/auto');
// `stream.pipeline` is now defined
const stream = require('stream');
// Use `stream.pipeline`
```
_Typescript:_
```js
import finishedShim from 'stream.pipeline-shim/shim';
finishedShim();
// `stream.pipeline` is now defined
import stream from 'stream';
// Use `stream.pipeline`
```
or:
```js
import 'stream.pipeline-shim/auto';
// `stream.pipeline` is now defined
import stream from 'stream';
// Use `stream.pipeline`
```
## License
Copyright (c) 2018-2019 Piotr Roszatycki <piotr.roszatycki@gmail.com>
Copyright Node.js contributors. All rights reserved.
Copyright (c) 2014 Mathias Buus
[MIT](https://opensource.org/licenses/MIT)