# Pattern Lab Node API

[](https://gitter.im/pattern-lab/node)

## [Installation](https://github.com/pattern-lab/patternlab-node#installation)

## Usage

`patternlab-node` can be required within any Node environment, taking in a configuration file at instantiation.

``` javascript

const config = require('./patternlab-config.json');

const patternlab = require('patternlab-node')(config);

```

## Events

Pattern Lab emits numerous [events](./events.md).

## Functions

Many of these functions are exposed to users within [Editions](https://github.com/pattern-lab/patternlab-node#editions), but [direct consumption](https://github.com/pattern-lab/patternlab-node#direct-consumption) is also encouraged.

{{#orphans ~}}

{{>heading-indent}}{{>sig-name}}

{{>deprecated~}}

{{>description~}}

{{>summary~}}

{{>augments~}}

{{>implements~}}

{{>mixes~}}

{{>default~}}

{{>chainable~}}

{{>overrides~}}

{{>returns~}}

{{>category~}}

{{>throws~}}

{{>fires~}}

{{>this~}}

{{>access~}}

{{>readOnly~}}

{{>requires~}}

{{>customTags~}}

{{>see~}}

{{>since~}}

{{>version~}}

{{>authors~}}

{{>license~}}

{{>copyright~}}

{{>todo~}}

{{>params~}}

{{>properties~}}

{{>examples~}}

* * *

[Pattern Lab](http://patternlab.io) Node is [MIT Licensed](https://github.com/pattern-lab/patternlab-node/blob/master/LICENSE)