https://github.com/sindresorhus/environment
Check which JavaScript environment your code is running in at runtime: browser, Node.js, Bun, etc
https://github.com/sindresorhus/environment
check-environment node-module npm-package runtime-environment
Last synced: 3 months ago
JSON representation
Check which JavaScript environment your code is running in at runtime: browser, Node.js, Bun, etc
- Host: GitHub
- URL: https://github.com/sindresorhus/environment
- Owner: sindresorhus
- License: mit
- Created: 2024-04-28T16:48:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-13T06:20:07.000Z (10 months ago)
- Last Synced: 2025-03-31T04:04:00.587Z (4 months ago)
- Topics: check-environment, node-module, npm-package, runtime-environment
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 162
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
README
# environment
> Check which JavaScript environment your code is running in at runtime
## Install
```sh
npm install environment
```
## Usage
```js
import {isBrowser, isNode} from 'environment';
if (isBrowser) {
console.log('Running in a browser!');
}
if (isNode) {
console.log('Running in Node.js!');
}
```
> [!NOTE]
> Runtime checks should be used sparingly. Prefer [conditional package exports](https://nodejs.org/api/packages.html#conditional-exports) and [imports](https://nodejs.org/api/packages.html#subpath-imports) whenever possible.
## API
### `isBrowser`
Check if the code is running in a web browser environment.
### `isNode`
Check if the code is running in a [Node.js](https://nodejs.org) environment.
### `isBun`
Check if the code is running in a [Bun](https://bun.sh) environment.
### `isDeno`
Check if the code is running in a [Deno](https://deno.com) environment.
### `isElectron`
Check if the code is running in an [Electron](https://www.electronjs.org) environment.
### `isJsDom`
Check if the code is running in a [jsdom](https://github.com/jsdom/jsdom) environment.
### `isWebWorker`
Check if the code is running in a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_global_contexts_and_functions) environment, which could be either a dedicated worker, shared worker, or service worker.
### `isDedicatedWorker`
Check if the code is running in a [Dedicated Worker](https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope) environment.
### `isSharedWorker`
Check if the code is running in a [Shared Worker](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorkerGlobalScope) environment.
### `isServiceWorker`
Check if the code is running in a [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope) environment.
### `isMacOs`
Check if the code is running on macOS.
### `isWindows`
Check if the code is running on Windows.
### `isLinux`
Check if the code is running on Linux.
### `isIos`
Check if the code is running on iOS.
### `isAndroid`
Check if the code is running on Android.
## Related
- [is-in-ci](https://github.com/sindresorhus/is-in-ci) - Check if the process is running in a CI environment
- [is64bit](https://github.com/sindresorhus/is64bit) - Check if the operating system CPU architecture is 64-bit or 32-bit
- [is](https://github.com/sindresorhus/is) - Type check values