# base-compose

> Selectively merge values from one or more generators onto the current application instance.

Latest version **0.2.1** (published 2016-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install base-compose
pnpm add base-compose
yarn add base-compose
bun add base-compose
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2016-06-11 |
| First published | 2016-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Brian Woodward |
| Maintainers | doowb, jonschlinkert |
| Keywords | base, compose |

## Links

- npm: https://www.npmjs.com/package/base-compose
- Repository: https://github.com/node-base/base-compose
- Issues: https://github.com/node-base/base-compose/issues
- npm.io page: https://npm.io/package/base-compose

## Dependencies (3)

- [copy-task](https://npm.io/package/copy-task.md) ^0.1.0
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^2.0.1
- [mixin-deep](https://npm.io/package/mixin-deep.md) ^1.1.3

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2016-06-11
- 0.2.0 — 2016-06-07
- 0.1.5 — 2016-05-07
- 0.1.4 — 2016-04-22
- 0.1.3 — 2016-04-21
- 0.1.2 — 2016-04-21
- 0.1.1 — 2016-02-04
- 0.1.0 — 2016-02-03

## README

# base-compose [![NPM version](https://img.shields.io/npm/v/base-compose.svg?style=flat)](https://www.npmjs.com/package/base-compose) [![NPM downloads](https://img.shields.io/npm/dm/base-compose.svg?style=flat)](https://npmjs.org/package/base-compose) [![Build Status](https://img.shields.io/travis/node-base/base-compose.svg?style=flat)](https://travis-ci.org/node-base/base-compose)

Selectively merge values from one or more generators onto the current application instance.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save base-compose
```

This plugin requires the [base-generators](https://github.com/node-base/base-generators) to be registered first. If not already registered, you can do so now by following [these instructions](#base-generators).

## Usage

```js
var compose = require('base-compose');
var Base = require('base');
var app = new Base();

// register the "compose" plugin
app.use(compose());
```

## API

**Heads up!**

Some of the methods exposed on [.compose](#methods) expect for `app` to be an instance of [templates](https://github.com/jonschlinkert/templates), or for specific plugins to be registered first.

You don't need to register all of the plugins prescribed below, just use the plugins you need with the methods you need. `base-compose` will give you detailed error messages when something is missing.

More information is provided in the [methods documentation](#methods) below.

### [.compose](index.js#L39)

Setup a composition by passing in an array of generators to compose elements. If a generator cannot be found, an error will be thrown.

**Params**

* `parent` **{Object}**: Parent generator to lookup generators.
* `names` **{String|Array}**: One or more generator names or instances.
* `returns` **{Object}**: Returns an instance of `Compose`

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .data()
  .options()
  .helpers()
  .views();
```

### [.compose.options](lib/compose.js#L44)

Merge the options from each generator into the `app` options. This method requires using the [base-option][base-option] plugin.

**Params**

* `key` **{String}**: Optionally pass the name of a property to merge from the `options` object. Dot-notation may be used for nested properties.
* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
a.option({foo: 'a'});
b.option({foo: 'b'});
c.option({foo: 'c'});

app.compose(base, ['a', 'b', 'c'])
  .options();

console.log(app.options);
//=> {foo: 'c'}
```

### [.compose.data](lib/compose.js#L76)

Merge the `cache.data` object from each generator onto the `app.cache.data` object. This method requires the `.data()` method from [templates](https://github.com/jonschlinkert/templates).

**Params**

* `key` **{String}**: Optionally pass a key to merge from the `data` object.
* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
a.data({foo: 'a'});
b.data({foo: 'b'});
c.data({foo: 'c'});

app.compose(base, ['a', 'b', 'c'])
  .data();

console.log(app.cache.data);
//=> {foo: 'c'}
```

### [.compose.engines](lib/compose.js#L105)

Merge the engines from each generator into the `app` engines. This method requires the `.engine()` methods from [templates](https://github.com/jonschlinkert/templates).

* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .engines();
```

### [.compose.helpers](lib/compose.js#L130)

Merge the helpers from each generator into `app.helpers`. Requires the `.helper` method from [templates](https://github.com/jonschlinkert/templates).

* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .helpers();
```

### [.compose.questions](lib/compose.js#L156)

Merge `generator.questions.cache` from specified generators onto `app.questions.cache`. Requires the [base-questions](https://github.com/node-base/base-questions) plugin to be registered.

* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .questions();
```

### [.compose.pipeline](lib/compose.js#L185)

Merge the pipeline plugins from each generator onto `app.plugins`. Requires the [base-pipeline](https://github.com/node-base/base-pipeline) plugin to be registered.

* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .pipeline();
```

### [.compose.tasks](lib/compose.js#L217)

Copy the specified tasks and task-dependencies from each generator onto `app.tasks`. Requires using the [base-task](https://github.com/node-base/base-task) plugin to be registered.

**Params**

* `tasks` **{String|Array}**: One or more task names (optional)
* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .tasks(['foo', 'bar', 'default']);

// or to copy all tasks
app.compose(base, ['a', 'b', 'c'])
  .tasks();
```

### [.compose.views](lib/compose.js#L246)

Copy view collections and views from each generator onto `app`. Expects `app` to be an instance of [templates](https://github.com/jonschlinkert/templates).

**Params**

* `names` **{Array|String}**: (optional) Names of one or more collections to copy. If undefined all collections will be copied.
* `filter` **{Function}**: Optionally pass a filter function to filter views copied from each collection. The filter function exposes `key`, `view` and `collection` as arguments. If used, the function must return `true` to copy a view.
* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .views();
```

### [.compose.iterator](lib/compose.js#L325)

Returns an iterator function for iterating over an array of generators. The iterator takes a `fn` that exposes the current generator being iterated over (`generator`) and the app passed into the original function as arguments. No binding is done within the iterator so the function passed in can be safely bound.

**Params**

* `names` **{Array}**: Names of generators to iterate over (optional).
* `iteratorFn` **{Function}**: Function to invoke for each generator in `generators`. Exposes `app` and `generator` as arguments.
* `returns` **{Object}**: Returns the `Compose` instance for chaining

**Example**

```js
app.compose(base, ['a', 'b', 'c'])
  .iterator(function(generator, app) {
    // do work
    app.data(generator.cache.data);
  });

// optionally pass an array of additional generator names as the
// first argument. If generator names are defined on `iterator`,
// any names passed to `.compose()` will be ignored.
app.compose(base, ['a', 'b', 'c'])
  .iterator(['d', 'e', 'f'], function(generator, app) {
    // do stuff to `generator` and `app`
  });
```

## base-generators

Follow these instructions to install and register the [base-generators](https://github.com/node-base/base-generators) plugin before registering `base-compose`.

**Install base-generators**

```sh
$ npm install base-generators --save
```

**Register base-generators**

```js
var generators = require('base-generators');
var compose = require('base-compose');
var Base = require('base');
var app = new Base();

// register plugins
app.use(generators());
app.use(compose());
```

## Related projects

You might also be interested in these projects:

* [assemble](https://www.npmjs.com/package/assemble): Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble "Assemble is a powerful, extendable and easy to use static site generator for node.js. Used by thousands of projects for much more than building websites, Assemble is also used for creating themes, scaffolds, boilerplates, e-books, UI components, API docum")
* [base](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/node-base/base) | [homepage](https://github.com/node-base/base "base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.")
* [generate](https://www.npmjs.com/package/generate): Fast, composable, highly pluggable project generator with a user-friendly and expressive API. | [homepage](https://github.com/generate/generate "Fast, composable, highly pluggable project generator with a user-friendly and expressive API.")
* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")

## Contributing

This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-readme-generator && verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Brian Woodward**

* [github/doowb](https://github.com/doowb)
* [twitter/doowb](http://twitter.com/doowb)

## License

Copyright © 2016, [Brian Woodward](https://github.com/doowb).
Released under the [MIT license](https://github.com/node-base/base-compose/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 11, 2016._

---
_Source: https://npm.io/package/base-compose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._