Browse Source

node-browser-environment => browser-env

pull/19/head
Luke Childs 8 years ago
parent
commit
9887b12b89
  1. 16
      README.md
  2. 8
      package.json

16
README.md

@ -1,4 +1,4 @@
# node-browser-environment [![Build Status](https://travis-ci.org/lukechilds/node-browser-environment.svg?branch=master)](https://travis-ci.org/lukechilds/node-browser-environment) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/node-browser-environment/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/node-browser-environment?branch=master) # browser-env [![Build Status](https://travis-ci.org/lukechilds/browser-env.svg?branch=master)](https://travis-ci.org/lukechilds/browser-env) [![Coverage Status](https://coveralls.io/repos/github/lukechilds/browser-env/badge.svg?branch=master)](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();
``` ```

8
package.json

@ -1,5 +1,5 @@
{ {
"name": "node-browser-environment", "name": "browser-env",
"version": "2.0.7", "version": "2.0.7",
"description": "Simulates a global browser environment using jsdom", "description": "Simulates a global browser environment using jsdom",
"main": "dist/index.js", "main": "dist/index.js",
@ -27,7 +27,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/lukechilds/node-browser-environment.git" "url": "git+https://github.com/lukechilds/browser-env.git"
}, },
"keywords": [ "keywords": [
"simulate", "simulate",
@ -39,9 +39,9 @@
"author": "Luke Childs <lukechilds123@gmail.com> (http://lukechilds.co.uk)", "author": "Luke Childs <lukechilds123@gmail.com> (http://lukechilds.co.uk)",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/lukechilds/node-browser-environment/issues" "url": "https://github.com/lukechilds/browser-env/issues"
}, },
"homepage": "https://github.com/lukechilds/node-browser-environment#readme", "homepage": "https://github.com/lukechilds/browser-env#readme",
"dependencies": { "dependencies": {
"jsdom": "9.6.0" "jsdom": "9.6.0"
}, },

Loading…
Cancel
Save