Skip to content

Commit 5ae3776

Browse files
committedJun 25, 2020
Add docs for isWebWorker and isJsDom
1 parent b39d40a commit 5ae3776

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed
 

‎README.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![npm version](https://badge.fury.io/js/browser-or-node.svg)](https://www.npmjs.com/package/browser-or-node)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
66

7-
87
Check whether the code is running in the browser or node.js runtime.
98

109
## Install
@@ -16,8 +15,9 @@ $ npm install --save browser-or-node
1615
## Usage
1716

1817
ES6 style import
18+
1919
```js
20-
import { isBrowser, isNode } from 'browser-or-node';
20+
import { isBrowser, isNode, isWebWorker, isJsDom } from "browser-or-node";
2121

2222
if (isBrowser) {
2323
// do browser only stuff
@@ -27,10 +27,19 @@ if (isNode) {
2727
// do node.js only stuff
2828
}
2929

30+
if (isWebWorker) {
31+
// do web worker only stuff
32+
}
33+
34+
if (isJsDom) {
35+
// do jsdom only stuff
36+
}
3037
```
38+
3139
ES5 style import
40+
3241
```js
33-
var jsEnv = require('browser-or-node');
42+
var jsEnv = require("browser-or-node");
3443

3544
if (jsEnv.isBrowser) {
3645
// do browser only stuff
@@ -40,6 +49,13 @@ if (jsEnv.isNode) {
4049
// do node.js only stuff
4150
}
4251

52+
if (jsEnv.isWebWorker) {
53+
// do web worker only stuff
54+
}
55+
56+
if (jsEnv.isJsDom) {
57+
// do jsdom only stuff
58+
}
4359
```
4460

4561
## License

0 commit comments

Comments
 (0)
Please sign in to comment.