You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
7 years ago
|
# with
|
||
|
|
|
||
|
|
Compile time `with` for strict mode JavaScript
|
||
|
|
|
||
|
|
[](http://travis-ci.org/ForbesLindesay/with)
|
||
|
|
[](https://gemnasium.com/ForbesLindesay/with)
|
||
|
|
[](http://badge.fury.io/js/with)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
$ npm install with
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var addWith = require('with')
|
||
|
|
|
||
|
|
addWith('obj', 'console.log(a)')
|
||
|
|
// => "var a = obj.a;console.log(a)"
|
||
|
|
|
||
|
|
addWith("obj || {}", "console.log(helper(a))", ["helper"])
|
||
|
|
// => var locals = (obj || {}),a = locals.a;console.log(helper(a))
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### addWith(obj, src, [exclude], [environments])
|
||
|
|
|
||
|
|
The idea is that this is roughly equivallent to:
|
||
|
|
|
||
|
|
```js
|
||
|
|
with (obj) {
|
||
|
|
src
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
There are a few differences though. For starters, it will be assumed that all variables used in `src` come from `obj` so any that don't (e.g. template helpers) need to have their names parsed to `exclude` as an array. If you want to have browser globals available you can pass a collection of `environments`, e.g.
|
||
|
|
|
||
|
|
```js
|
||
|
|
addWith('obj', 'document.createElement(foo)', [], ['reservedVars', 'ecmaIdentifiers', 'nonstandard', 'browser'])
|
||
|
|
```
|
||
|
|
|
||
|
|
The default environment is: `['reservedVars', 'ecmaIdentifiers', 'nonstandard', 'node']`
|
||
|
|
|
||
|
|
It also makes everything be declared, so you can always do:
|
||
|
|
|
||
|
|
```js
|
||
|
|
if (foo === undefined)
|
||
|
|
```
|
||
|
|
|
||
|
|
instead of
|
||
|
|
|
||
|
|
```js
|
||
|
|
if (typeof foo === 'undefined')
|
||
|
|
```
|
||
|
|
|
||
|
|
It is also safe to use in strict mode (unlike `with`) and it minifies properly (`with` disables virtually all minification).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|