https://github.com/shinnn/deep-extend-stream

Recursively extend the object in a stream
https://github.com/shinnn/deep-extend-stream

Last synced: 27 days ago
JSON representation

Recursively extend the object in a stream

• Host: GitHub
• URL: https://github.com/shinnn/deep-extend-stream
• Owner: shinnn
• License: isc
• Created: 2014-12-16T03:54:32.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-05-05T08:03:20.000Z (over 6 years ago)
• Last Synced: 2024-10-10T16:34:27.847Z (about 1 month ago)
• Language: JavaScript
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# deep-extend-stream

[![npm version](http://img.shields.io/npm/v/deep-extend-stream.svg)](https://www.npmjs.com/package/deep-extend-stream)

[![Build Status](http://img.shields.io/travis/shinnn/deep-extend-stream.svg)](https://travis-ci.org/shinnn/deep-extend-stream)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/deep-extend-stream.svg)](https://coveralls.io/github/shinnn/deep-extend-stream)

Recursively extend the object in a stream

```javascript

const deepExtend = require('deep-extend-stream');

const target = {foo: {bar: 123}};

const deepExtendStream = deepExtend(target);

deepExtendStream.write({foo: {baz: 'Hello'}});

deepExtendStream.write({qux: 'World'});

deepExtendStream.on('finish', () => {

  target; //=> {foo: {bar: 123, baz: 'Hello'}, qux: 'World'}

});

deepExtendStream.end();

```

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).

```

npm install deep-extend-stream

```

## API

```javascript

const deepExtend = require('deep-extend-stream');

```

### deepExtend([*target*,] [*callback*])

*target*: `Object` or `Array`  

*callback*: `Function`  

Return: [`stream.Transform`](https://iojs.org/api/stream.html#stream_class_stream_transform_1)

It returns a transform stream that recursively extends the target object with passed objects (what is called "deep extend").

Target object is optional (`{}` by default).

```javascript

const deepExtend = require('deep-extend-stream');

const deepExtendStream = deepExtend();

deepExtendStream

.on('finish', function() {

  // this._target is an internal property to keep target object

  this._target;

  /*=> {

    '0': 'a',

    '1': {

      b: 'c',

      d: 'e'

    },

    '2': 'f'

  } */

})

.write(['a', {'b': 'c'}, 'f'])

.write({'1': {'d': 'e'}})

.end();

```

#### callback(target)

You can specify a function to be called on [`finish`](https://iojs.org/api/stream.html#stream_events_finish_and_end) event. It will be called with the target object as its first argument.

```javascript

const deepExtend = require('deep-extend-stream');

deepExtend(target => {

  target; //=> [0, 1, 2]

}).end([0, 1, 2]);

deepExtend([0, 1, 2], target => {

  target; //=> [0, 1, 2]

}).end();

```

## License

[ISC License](./LICENSE) © 2017 - 2018 Shinnosuke Watanabe