# engine-lodash

> Lo-Dash engine, consolidate.js style but with enhancements. Works with Assemble, express.js, engine-cache or any application that follows consolidate.js conventions.

Latest version **0.8.2** (published 2015-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install engine-lodash
pnpm add engine-lodash
yarn add engine-lodash
bun add engine-lodash
```

## 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.8.2 |
| Published | 2015-08-21 |
| First published | 2014-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7 |
| Author | https://github.com/jonschlinkert |
| Maintainers | jonschlinkert, doowb |
| Keywords | engine, consolidate, express, assemble, lodash, lo-dash, underscore, templates, template, compile, render, process, delimiters, delims |

## Links

- npm: https://www.npmjs.com/package/engine-lodash
- Repository: https://github.com/jonschlinkert/engine-lodash
- Issues: https://github.com/jonschlinkert/engine-lodash/issues
- npm.io page: https://npm.io/package/engine-lodash

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [ansi-red](https://npm.io/package/ansi-red.md) ^0.1.1
- [lazy-cache](https://npm.io/package/lazy-cache.md) ^0.2.3
- [engine-utils](https://npm.io/package/engine-utils.md) ^0.1.1
- [delimiter-regex](https://npm.io/package/delimiter-regex.md) ^1.3.1

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.8.2 (latest) — 2015-08-21
- 0.8.0 — 2015-08-21
- 0.7.1 — 2015-06-15
- 0.7.0 — 2015-06-01
- 0.6.3 — 2015-04-21
- 0.6.2 — 2015-04-01
- 0.6.1 — 2015-04-01
- 0.5.0 — 2015-02-03
- 0.4.3 — 2015-02-01
- 0.4.2 — 2015-02-01
- 0.4.0 — 2014-11-11
- 0.3.5 — 2014-11-07
- 0.3.3 — 2014-10-28
- 0.3.2 — 2014-10-24
- 0.3.1 — 2014-10-24
- … 5 more at https://npm.io/package/engine-lodash/versions

## README

# engine-lodash [![NPM version](https://badge.fury.io/js/engine-lodash.svg)](http://badge.fury.io/js/engine-lodash)  [![Build Status](https://travis-ci.org/jonschlinkert/engine-lodash.svg)](https://travis-ci.org/jonschlinkert/engine-lodash)

> Lo-Dash engine, consolidate.js style but with enhancements. Works with Assemble, express.js, engine-cache or any application that follows consolidate.js conventions.

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

```sh
$ npm i engine-lodash --save
```

## Usage

```js
var lodash = require('engine-lodash');
```

## API

### [.render](index.js#L56)

Lodash string support. Render the given `str` and invoke the callback `callback(err, str)`.

**Params**

* `str` **{String}**
* `options` **{Object|Function}**: or callback.
* `callback` **{Function}**

**Example**

```js
var engine = require('engine-lodash');
engine.render('<%= name %>', {name: 'Jon'}, function (err, content) {
  console.log(content); //=> 'Jon'
});
```

### [.renderSync](index.js#L140)

Render Lo-Dash or underscore templates synchronously.

**Params**

* `str` **{Object}**: The string to render.
* `options` **{Object}**: Object of options.
* `returns` **{String}**: Rendered string.

**Example**

```js
var engine = require('engine-lodash');
engine.renderSync('<%= name %>', {name: 'Halle'});
//=> 'Halle'
```

### [.renderFile](index.js#L171)

Lodash file support. Render a file at the given `filepath` and callback `callback(err, str)`.

**Params**

* `path` **{String}**
* `options` **{Object|Function}**: or callback function.
* `callback` **{Function}**

**Example**

```js
var engine = require('engine-lodash');
engine.renderFile('foo/bar/baz.tmpl', {name: 'Halle'});
//=> 'Halle'
```

## Related projects

* [engine-cache](https://www.npmjs.com/package/engine-cache): express.js inspired template-engine manager. | [homepage](https://github.com/jonschlinkert/engine-cache)
+ [engine-handlebars](https://www.npmjs.com/package/engine-handlebars): Handlebars engine, consolidate.js style but with enhancements. This works with Assemble, express.js, engine-cache or any… [more](https://www.npmjs.com/package/engine-handlebars) | [homepage](https://github.com/jonschlinkert/engine-handlebars)
+ [engine-less](https://www.npmjs.com/package/engine-less): Consolidate-style engine for rendering .less files. | [homepage](https://github.com/jonschlinkert/engine-less)
+ [helper-cache](https://www.npmjs.com/package/helper-cache): Easily register and get helper functions to be passed to any template engine or node.js… [more](https://www.npmjs.com/package/helper-cache) | [homepage](https://github.com/jonschlinkert/helper-cache)
+ [template](https://www.npmjs.com/package/template): Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… [more](https://www.npmjs.com/package/template) | [homepage](https://github.com/jonschlinkert/template)
+ [template-helpers](https://www.npmjs.com/package/template-helpers): Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… [more](https://www.npmjs.com/package/template-helpers) | [homepage](https://github.com/jonschlinkert/template-helpers)

## Authors

**Jon Schlinkert**

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

**Brian Woodward**

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

## License

Copyright © 2014-2015 https://github.com/jonschlinkert
Released under the MIT license.

***

_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 21, 2015._

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