is-where 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Luca Ban - Mesqueeb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# is Where? 🙈
+
+<a href="https://www.npmjs.com/package/is-where"><img src="https://img.shields.io/npm/v/is-where.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/is-where"><img src="https://img.shields.io/npm/dw/is-where.svg" alt="Latest Stable Version"></a>
+
+Very simple & small JS environment check functions.
+
+```
+npm i is-where
+```
+
+<!-- Or for deno available at: `"deno.land/x/is_where"` -->
+
+> Also check out [is-what 🙉](https://github.com/mesqueeb/is-what)
+
+## Motivation
+
+I built is-where because I kept Stack Overflowing the same things for every project.
+
+I was looking for:
+
+- A simple way to check which environment (Node, Browser, Deno, ...)
+- A simple way to check for which browser (WebKit, Safari, Chrome, Firefox, ...)
+- Functions that don't crash when executed in any environment
+- 0 dependencies
+
+## Usage
+
+is-where is really easy to use, and most functions work just like you'd expect.
+
+```js
+// import functions you want to use like so:
+import { isBrowser, isNode, isWebKit } from 'is-where'
+```
+
+```js
+isBrowser() // true / false
+isNode() // true / false
+isWebKit() // true / false
+```
+
+### List of functions
+
+Environments
+
+- `isNode()`
+- `isBrowser()`
+- `isWebWorker()`
+- `isJsDom()`
+- `isDeno()`
+
+Browsers
+
+- `isWebKit()`
+- `isSafari()`
+
+## Meet the family
+
+- [is-what 🙉](https://github.com/mesqueeb/is-what)
+- [is-where 🙈](https://github.com/mesqueeb/is-where)
+- [merge-anything 🥡](https://github.com/mesqueeb/merge-anything)
+- [filter-anything ⚔️](https://github.com/mesqueeb/filter-anything)
+- [find-and-replace-anything 🎣](https://github.com/mesqueeb/find-and-replace-anything)
+- [compare-anything 🛰](https://github.com/mesqueeb/compare-anything)
+- [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
+- [flatten-anything 🏏](https://github.com/mesqueeb/flatten-anything)
+
+## Source code
+
+See the full source code [here](https://github.com/mesqueeb/is-where/blob/production/src/index.ts).

package/dist/index.cjs

@@ -0,0 +1,82 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * returns `true` if the current environment is Node
+ */
+function isNode() {
+    return typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
+}
+/**
+ * returns `true` if the current environment is a browser
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+/**
+ * returns `true` if the current environment is a Web Worker
+ */
+function isWebWorker() {
+    return (typeof self === 'object' &&
+        self.constructor &&
+        self.constructor.name === 'DedicatedWorkerGlobalScope');
+}
+/**
+ * returns `true` if the current environment is JS DOM
+ */
+function isJsDom() {
+    return ((typeof window !== 'undefined' && window.name === 'nodejs') ||
+        (typeof navigator !== 'undefined' &&
+            (navigator.userAgent.includes('Node.js') || navigator.userAgent.includes('jsdom'))));
+}
+/**
+ * returns `true` if the current environment is Deno
+ */
+function isDeno() {
+    // @ts-ignore
+    return typeof Deno !== 'undefined' && typeof Deno.core !== 'undefined';
+}
+/**
+ * returns `true` if the current browser is based on WebKit
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ * - Google Chrome on iOS & iPadOS
+ * - Firefox on iOS & iPadOS
+ * - ... on iOS & iPadOS
+ *
+ * All mobile browsers on iOS & iPadOS use WebKit
+ */
+function isWebKit() {
+    return (isBrowser() &&
+        !!navigator.vendor &&
+        navigator.vendor.indexOf('Apple') !== -1 &&
+        !!navigator.userAgent);
+}
+/**
+ * returns `true` if the current browser is Safari
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ *
+ * It does not include other browser on iOS & iPadOS
+ */
+function isSafari() {
+    return (isBrowser() &&
+        !!navigator.vendor &&
+        navigator.vendor.indexOf('Apple') !== -1 &&
+        !!navigator.userAgent &&
+        navigator.userAgent.indexOf('CriOS') == -1 &&
+        navigator.userAgent.indexOf('FxiOS') == -1);
+}
+
+exports.isBrowser = isBrowser;
+exports.isDeno = isDeno;
+exports.isJsDom = isJsDom;
+exports.isNode = isNode;
+exports.isSafari = isSafari;
+exports.isWebKit = isWebKit;
+exports.isWebWorker = isWebWorker;

package/dist/index.es.js

@@ -0,0 +1,72 @@
+/**
+ * returns `true` if the current environment is Node
+ */
+function isNode() {
+    return typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
+}
+/**
+ * returns `true` if the current environment is a browser
+ */
+function isBrowser() {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+}
+/**
+ * returns `true` if the current environment is a Web Worker
+ */
+function isWebWorker() {
+    return (typeof self === 'object' &&
+        self.constructor &&
+        self.constructor.name === 'DedicatedWorkerGlobalScope');
+}
+/**
+ * returns `true` if the current environment is JS DOM
+ */
+function isJsDom() {
+    return ((typeof window !== 'undefined' && window.name === 'nodejs') ||
+        (typeof navigator !== 'undefined' &&
+            (navigator.userAgent.includes('Node.js') || navigator.userAgent.includes('jsdom'))));
+}
+/**
+ * returns `true` if the current environment is Deno
+ */
+function isDeno() {
+    // @ts-ignore
+    return typeof Deno !== 'undefined' && typeof Deno.core !== 'undefined';
+}
+/**
+ * returns `true` if the current browser is based on WebKit
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ * - Google Chrome on iOS & iPadOS
+ * - Firefox on iOS & iPadOS
+ * - ... on iOS & iPadOS
+ *
+ * All mobile browsers on iOS & iPadOS use WebKit
+ */
+function isWebKit() {
+    return (isBrowser() &&
+        !!navigator.vendor &&
+        navigator.vendor.indexOf('Apple') !== -1 &&
+        !!navigator.userAgent);
+}
+/**
+ * returns `true` if the current browser is Safari
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ *
+ * It does not include other browser on iOS & iPadOS
+ */
+function isSafari() {
+    return (isBrowser() &&
+        !!navigator.vendor &&
+        navigator.vendor.indexOf('Apple') !== -1 &&
+        !!navigator.userAgent &&
+        navigator.userAgent.indexOf('CriOS') == -1 &&
+        navigator.userAgent.indexOf('FxiOS') == -1);
+}
+
+export { isBrowser, isDeno, isJsDom, isNode, isSafari, isWebKit, isWebWorker };

package/dist/types/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * returns `true` if the current environment is Node
+ */
+export declare function isNode(): boolean;
+/**
+ * returns `true` if the current environment is a browser
+ */
+export declare function isBrowser(): boolean;
+/**
+ * returns `true` if the current environment is a Web Worker
+ */
+export declare function isWebWorker(): boolean;
+/**
+ * returns `true` if the current environment is JS DOM
+ */
+export declare function isJsDom(): boolean;
+/**
+ * returns `true` if the current environment is Deno
+ */
+export declare function isDeno(): boolean;
+/**
+ * returns `true` if the current browser is based on WebKit
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ * - Google Chrome on iOS & iPadOS
+ * - Firefox on iOS & iPadOS
+ * - ... on iOS & iPadOS
+ *
+ * All mobile browsers on iOS & iPadOS use WebKit
+ */
+export declare function isWebKit(): boolean;
+/**
+ * returns `true` if the current browser is Safari
+ *
+ * This includes:
+ * - Safari on macOS
+ * - Safari on iOS & iPadOS
+ *
+ * It does not include other browser on iOS & iPadOS
+ */
+export declare function isSafari(): boolean;

package/package.json

@@ -0,0 +1,118 @@
+{
+  "name": "is-where",
+  "sideEffects": false,
+  "type": "module",
+  "version": "1.0.0",
+  "description": "JS environment check functions like `isWebkit() isSafari() isBrowser() isNode()` etc. A simple & small integration.",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mesqueeb/is-where.git"
+  },
+  "keywords": [
+    "javascript",
+    "typescript",
+    "envchecker",
+    "check-environment",
+    "check-browser",
+    "is-browser",
+    "is-node",
+    "is-deno",
+    "is-safari",
+    "is-chrome",
+    "is-webkit",
+    "is-edge",
+    "is-firefox",
+    "is-opera",
+    "is-ie",
+    "is-ssr",
+    "is-server",
+    "browser-checking",
+    "browser-checker",
+    "browser-check",
+    "environment-checking",
+    "environment-checker",
+    "environment-check"
+  ],
+  "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mesqueeb/is-where/issues"
+  },
+  "homepage": "https://github.com/mesqueeb/is-where#readme",
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.1",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.3"
+  },
+  "ava": {
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=ts-node/esm"
+    ]
+  },
+  "np": {
+    "yarn": false,
+    "branch": "production"
+  },
+  "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint",
+      "tree-shaking"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
+    ],
+    "rules": {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-ts-ignore": "off",
+      "tree-shaking/no-side-effects-in-initialization": "error",
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
+  }
+}