# wiretree

> Node.js dependency injection framework

Latest version **1.3.2** (published 2015-04-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install wiretree
pnpm add wiretree
yarn add wiretree
bun add wiretree
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2015-04-27 |
| First published | 2014-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 46 |
| Author | Jacobo Tabernero - jacobo@xarope.eu |
| Maintainers | jacoborus |
| Keywords | dependency, injection, framework, plugin |

## Links

- npm: https://www.npmjs.com/package/wiretree
- Repository: git@github.com:jacoborus/wiretree
- Homepage: http://wiretree.micronube.com/
- Issues: https://github.com/jacoborus/wiretree/issues
- npm.io page: https://npm.io/package/wiretree

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads
- [@modern-js/plugin-swc](https://npm.io/package/@modern-js/plugin-swc.md) — 3.4K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2015-04-27
- 1.3.1 — 2015-04-23
- 1.3.0 — 2015-04-05
- 1.2.1 — 2015-03-23
- 1.2.0 — 2015-03-23
- 1.1.0 — 2015-03-23
- 1.0.1 — 2015-03-10
- 1.0.0 — 2015-03-10
- 0.6.0 — 2015-02-22
- 0.5.1 — 2015-02-22
- 0.5.0 — 2014-08-16
- 0.4.1 — 2014-08-11
- 0.4.0 — 2014-07-26
- 0.3.2 — 2014-07-25
- 0.3.1 — 2014-07-23
- … 16 more at https://npm.io/package/wiretree/versions

## README

![Wiretree](https://raw.githubusercontent.com/jacoborus/wiretree/master/brand/wiretreeGreen.png 'Wiretree logo')
================================================================================================================

Elegant dependency injection framework for Node.js.

[wiretree.jacoborus.codes](http://wiretree.jacoborus.codes/)

[![Build Status](https://travis-ci.org/jacoborus/wiretree.svg?branch=master)](https://travis-ci.org/jacoborus/wiretree)


Wiretree creates a tree with your framework configuration, then it will start your app resolving each plugin of tree by passing one or more dependencies to it. Wiretree enables to extend apps by adding more plugins without changing configuration.

Plugins can be simple node.js modules or preconfigured (at resolve time) ones, they can require another plugins or modules as dependencies, as well as return their value asynchronously.

A Wiretree plugin constructor is a function exposed as 'wiretree' in a nodejs module, its dependencies are declared as its arguments, and the value of resolved plugin is the returned value of constructor function:
```js
exports.wiretree = function (dependencyPlugin) {
    var myPlugin;
    // do something with myPlugin and dependencyPlugin
    // ...
    // and return your plugin
    return myPlugin;
};
```

Plugin constructors can be resolved asynchronously by passing its value through `wtDone` (`wtDone` is injected by Wiretree):
```js
exports.wiretree = function (wtDone) {
    doSomeAsyncOp( function (value) {
        // expose plugin
        wtDone( value );
    });
};
```


Installation
------------

```
npm install wiretree
```

API
---


- [Wiretree](#Wiretree)
- [then](#then)
- [add](#add)
- [load](#load)
- [folder](#folder)
- [resolve](#resolve)

<a name="Wiretree"></a>
### Wiretree( folderPath )

Wiretree constructor.
Creates new tree

**Parameters:**

- **folderPath** *String*: path to root folder

Example:

```javascript
var Wiretree = require('wiretree');
var tree = new Wiretree( 'path/to/rootFolder');
```

<a name="then"></a>
### then( fn )

Executes a function and then return the tree

**Parameters:**
- **fn** *Function*: function
- **Return** *Object*: tree

Example:

```js
tree
.add('mod', 1)
.then( function () {
    console.log( 'mod is added!');
})
.add(.....)
........
```

<a name="add"></a>
### add( key, value, options )

Add a module or wiretree plugin into the tree.
Returns tree object

**Parameters:**

- **key** *String*: name for the plugin
- **value** *Number|String|Boolean|Object|Function*: plugin
- **options** *Object*: (optional) see options
- **Return** *Object*: tree

All options are optional:

- **`group`** *String*: group to add the plugin
- **`localname`** *Function*: keyname into its group. Only works when group is passed
- **`hidden`** *Boolean*: expose only in group, not in tree root. Only works when group is passed
- **`processing`** *Function*: processing function module


**Example**:

```javascript
// add a simple module
tree.add( 'one', 1 );
// now 'one' in tree equals 1

// add a Wiretree plugin (a module with dependencies from tree)
.add( 'plugin', {
    wiretree: function (one) {
        return one() + 2;
    }
});
// now 'plugin in tree equals 3'
```

**Async plugin example**:

Expose plugin through 'wtDone' dependency instead returning it from function
```js
tree.add( 'asyncPlugin', {
    wiretree: function (wtDone) {
        doSomethingAsync( function (value) {
            wtDone( value );
        });
    }
});
```

**Group example**:

Passing a `group` will add the module to it. `localName` is how plugin will be exposed as into the group. `localName` is passed `key` by default

```javascript
tree.add( 'homeCtrl', 1, {
    group: 'control',
    localname: 'home'
});
// plugin is exposed as 'homeCtrl' in main tree, and as 'home' in 'control' group
// so you can inject it into other modules through main tree:
var otherPlugin = function (homeCtrl) {
    // do something with homeCtrl
};
// or through its group:
var anotherPlugin = function (control) {
var homeCtrl = control.home;
    // do something with homeCtrl
};
```

<a name="load"></a>
### load( filePath, options )

Add a plugin to tree from a file

**Parameters:**
- **filePath** *String*: path to js file
- **options** *Object*: exposing options. See **options** below
- **Return** *Object*: tree

*Options:*

- **`key`** *String*: use this value instead filename as plugin keyname in main tree.
- **`group`** *String*: group to add the plugin
- **`localname`** *String*: use this value as keyname into its group. (Only works when group is passed)
- **`hidden`** *Boolean*: expose only in group, not in tree root. (Only works when group is passed)
- **`processing`** *Function*: processing function module

Add the plugin as 'user' into the tree:
```js
tree.load( './user.js');
```

Add the plugin as 'userCtrl' into the tree and as 'user' into 'controllers' group:
```js
tree.load( './user.js', {
    key: 'userCtrl'
    group: 'controllers',
    localname: 'user'
});
```

<a name="folder"></a>
### folder( folderPath, options )

Load every javascript file in `folderPath`.

**Parameters:**

- **folderPath** *String*: path to folder
- **options** *Object*: All options are optional. See options below
- **Return** *Object*: tree

*Options*:

- **`group`** *String*: group to add the plugin
- **`transform`** *Function*: get keyname passed as argument and return new keyname
- **`prefix`** *String*: add prefix to keyname
- **`suffix`** *String*: add suffix to keyname
- **`hidden`** *Boolean*: expose only in group, not in tree root. Only works when group is passed
- **`processing`** *Function*: processing function module

Example: load all javascript files in 'controllers' folder into 'controllers' group and expose them in main tree with 'Ctrl' suffix

```js
tree.load( './controllers', {
    group: 'controllers',
    suffix: 'Ctrl'
});
```

<a name="resolve"></a>
### resolve( callback )

Resolve all plugins and launch callback

**Parameters:**

- **callback** *Function*: to do after resolve tree

Example:
```js
tree
.folder('./my_folder')
.resolve( function () {
    console.log( 'App is running!' );
});
```

<a name="get"></a>
### get( plugin )

Get a resolved plugin

**Parameters:**

- **`plugin`** *String*: name of the plugin
- **return** ***: resolved plugin

Example:

```js
var thisPlugin = tree.get('myPluginName');
```




Tests
-----

```
npm install && npm test
```


Build API docs
--------------

```
npm install && npm run build-docs
```

<br><br>

---

© 2015 Jacobo Tabernero - [jacoborus](http://jacoborus.codes)

Released under [MIT License](https://raw.github.com/jacoborus/wiretree/master/LICENSE)

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