Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 35 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,27 @@ This package is available on npm as:
npm install dustjs-browserify
```

## Browserify config example
## Browserify `package.json` example

```
transform: [
[
{
path : 'lib/templates'
promise : true
},
'dustjs-browserify'
]
]
{
...
"browserify": {
"transform": [
[
{
"path" : "lib/templates",
"promises" : "bluebird"
},
"dustjs-browserify"
]
]
},
...
"devDependencies": {
"bluebird": "*"
}
}
```

## Code examples
Expand All @@ -58,12 +67,14 @@ template({ foo : 42 }, function (error, html) {
});
```

Example using a promise:
Example using a promise library such as `bluebird`:

```
require('dustjs-loader').register({
path : 'lib/templates',
promise : true
path : 'lib/templates',

// Promises library you with to use, please make sure it `npm install` it.
promises : 'bluebird'
});

var template = require('./template.dust');
Expand All @@ -77,6 +88,17 @@ template({ foo : 42 })
});
```

Example using ES6 promise:

```
require('dustjs-loader').register({
path : 'lib/templates',

// Will use promises but won't require any libraries expecting browser to provide.
promises : true
});
```

Both of these examples will work on the server and in the browser.

## Dustjs documentation
Expand Down
6 changes: 5 additions & 1 deletion lib/dustjs-browserify.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,11 @@ module.exports = function (filename, options) {
template = requires + template;

if (options.promise) {
compiled = DustjsModulize.wrapWithPromise(name, template);
throw new Error('dustjs-browserify: `promise` option is deprecated. Please see README.');
}

if (options.promises) {
compiled = DustjsModulize.wrapWithPromise(name, template, options.promises);
} else {
compiled = DustjsModulize.wrap(name, template);
}
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
},
"homepage": "https://github.com/scottbrady/dustjs-browserify",
"dependencies": {
"bluebird": "~2.7.1",
"dustjs-linkedin": "~2.5.1",
"dustjs-loader": "~1.0.0",
"through": "~2.3.6"
Expand Down