|
@ -1,4 +1,4 @@ |
|
|
# node-browser-environment [](https://travis-ci.org/lukechilds/node-browser-environment) [](https://coveralls.io/github/lukechilds/node-browser-environment?branch=master) |
|
|
# browser-env [](https://travis-ci.org/lukechilds/browser-env) [](https://coveralls.io/github/lukechilds/browser-env?branch=master) |
|
|
|
|
|
|
|
|
Simulates a global browser environment using [`jsdom`](https://github.com/tmpvar/jsdom). |
|
|
Simulates a global browser environment using [`jsdom`](https://github.com/tmpvar/jsdom). |
|
|
|
|
|
|
|
@ -11,14 +11,14 @@ This allows you to run browser modules in node with minimal or no effort. Can al |
|
|
## Install |
|
|
## Install |
|
|
|
|
|
|
|
|
```shell |
|
|
```shell |
|
|
npm install --save node-browser-environment |
|
|
npm install --save browser-env |
|
|
``` |
|
|
``` |
|
|
|
|
|
|
|
|
## Usage |
|
|
## Usage |
|
|
|
|
|
|
|
|
```js |
|
|
```js |
|
|
// Init |
|
|
// Init |
|
|
require('node-browser-environment')(); |
|
|
require('browser-env')(); |
|
|
|
|
|
|
|
|
// Now you have access to a browser like environment in node: |
|
|
// Now you have access to a browser like environment in node: |
|
|
|
|
|
|
|
@ -39,7 +39,7 @@ By default everything in the `jsdom` window namespace is tacked on to the node g |
|
|
|
|
|
|
|
|
```js |
|
|
```js |
|
|
// Init |
|
|
// Init |
|
|
require('node-browser-environment')(['window']); |
|
|
require('browser-env')(['window']); |
|
|
|
|
|
|
|
|
typeof window; |
|
|
typeof window; |
|
|
// 'object' |
|
|
// 'object' |
|
@ -51,22 +51,22 @@ typeof document; |
|
|
You can also pass a config object straight through to `jsdom`. This can be done with or without specifying required properties. |
|
|
You can also pass a config object straight through to `jsdom`. This can be done with or without specifying required properties. |
|
|
|
|
|
|
|
|
```js |
|
|
```js |
|
|
require('node-browser-environment')(['window'], { userAgent: 'My User Agent' }); |
|
|
require('browser-env')(['window'], { userAgent: 'My User Agent' }); |
|
|
|
|
|
|
|
|
// or |
|
|
// or |
|
|
|
|
|
|
|
|
require('node-browser-environment')({ userAgent: 'My User Agent' }); |
|
|
require('browser-env')({ userAgent: 'My User Agent' }); |
|
|
``` |
|
|
``` |
|
|
|
|
|
|
|
|
You can of course also assign to a function: |
|
|
You can of course also assign to a function: |
|
|
|
|
|
|
|
|
```js |
|
|
```js |
|
|
var browserEnv = require('node-browser-environment'); |
|
|
var browserEnv = require('browser-env'); |
|
|
browserEnv(); |
|
|
browserEnv(); |
|
|
|
|
|
|
|
|
// or |
|
|
// or |
|
|
|
|
|
|
|
|
import browserEnv from 'node-browser-environment'; |
|
|
import browserEnv from 'browser-env'; |
|
|
browserEnv(); |
|
|
browserEnv(); |
|
|
``` |
|
|
``` |
|
|
|
|
|
|
|
|