@common.js/is-ip 5.0.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/is-ip
+
+The [is-ip](https://www.npmjs.com/package/is-ip) package exported as CommonJS modules.
+
+Exported from [is-ip@5.0.0](https://www.npmjs.com/package/is-ip/v/5.0.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,60 @@
+/**
+Check if `string` is IPv6 or IPv4.
+
+@example
+```
+import {isIP} from 'is-ip';
+
+isIP('1:2:3:4:5:6:7:8');
+//=> true
+
+isIP('192.168.0.1');
+//=> true
+```
+*/
+export function isIP(string: string): boolean; // eslint-disable-line @typescript-eslint/naming-convention
+
+/**
+Check if `string` is IPv6.
+
+@example
+```
+import {isIPv6} from 'is-ip';
+
+isIPv6('1:2:3:4:5:6:7:8');
+//=> true
+```
+*/
+export function isIPv6(string: string): boolean; // eslint-disable-line @typescript-eslint/naming-convention
+
+/**
+Check if `string` is IPv4.
+
+@example
+```
+import {isIPv4} from 'is-ip';
+
+isIPv4('192.168.0.1');
+//=> true
+```
+*/
+export function isIPv4(string: string): boolean; // eslint-disable-line @typescript-eslint/naming-convention
+
+/**
+@returns `6` if `string` is IPv6, `4` if `string` is IPv4, or `undefined` if `string` is neither.
+
+@example
+```
+import {ipVersion} from 'is-ip';
+
+ipVersion('1:2:3:4:5:6:7:8');
+//=> 6
+
+ipVersion('192.168.0.1');
+//=> 4
+
+ipVersion('abc');
+//=> undefined
+```
+*/
+export function ipVersion(string: string): 6 | 4 | undefined;

package/index.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    isIP: function() {
+        return isIP;
+    },
+    isIPv6: function() {
+        return isIPv6;
+    },
+    isIPv4: function() {
+        return isIPv4;
+    },
+    ipVersion: function() {
+        return ipVersion;
+    }
+});
+var _ipRegex = /*#__PURE__*/ _interopRequireDefault(require("ip-regex"));
+var _superRegex = require("super-regex");
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+var maxIPv4Length = 15;
+var maxIPv6Length = 45;
+var options = {
+    timeout: 400
+};
+function isIP(string) {
+    return (0, _superRegex.isMatch)((0, _ipRegex.default)({
+        exact: true
+    }), string.slice(0, maxIPv6Length), options);
+}
+function isIPv6(string) {
+    return (0, _superRegex.isMatch)(_ipRegex.default.v6({
+        exact: true
+    }), string.slice(0, maxIPv6Length), options);
+}
+function isIPv4(string) {
+    return (0, _superRegex.isMatch)(_ipRegex.default.v4({
+        exact: true
+    }), string.slice(0, maxIPv4Length), options);
+}
+function ipVersion(string) {
+    return isIP(string) ? isIPv6(string) ? 6 : 4 : undefined;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@common.js/is-ip",
+  "version": "5.0.0",
+  "description": "Check if a string is an IP address",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "types": "./index.d.ts",
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@common.js/ip-regex": "^5.0.0",
+    "@common.js/super-regex": "^0.2.0"
+  },
+  "devDependencies": {
+    "ava": "^4.3.1",
+    "tsd": "^0.22.0",
+    "xo": "^0.51.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "main": "./index.js"
+}

package/readme.md

@@ -0,0 +1,63 @@
+# is-ip
+
+> Check if a string is an IP address
+
+If you only need this for Node.js and don't care about browser support, you may want to use [`net.isIP`](https://nodejs.org/api/net.html#net_net_isip_input) instead. Note that it returns an integer instead of a boolean.
+
+## Install
+
+```sh
+npm install is-ip
+```
+
+## Usage
+
+```js
+import {isIP, isIPv4} from 'is-ip';
+
+isIP('1:2:3:4:5:6:7:8');
+//=> true
+
+isIP('192.168.0.1');
+//=> true
+
+isIPv4('1:2:3:4:5:6:7:8');
+//=> false
+```
+
+## API
+
+### isIP(string)
+
+Check if `string` is IPv6 or IPv4.
+
+### isIPv6(string)
+
+Check if `string` is IPv6.
+
+### isIPv4(string)
+
+Check if `string` is IPv4.
+
+### ipVersion(string)
+
+Returns `6` if `string` is IPv6, `4` if `string` is IPv4, or `undefined` if `string` is neither.
+
+```js
+import {ipVersion} from 'is-ip';
+
+ipVersion('1:2:3:4:5:6:7:8');
+//=> 6
+
+ipVersion('192.168.0.1');
+//=> 4
+
+ipVersion('abc');
+//=> undefined
+```
+
+## Related
+
+- [ip-regex](https://github.com/sindresorhus/ip-regex) - Regular expression for matching IP addresses
+- [is-cidr](https://github.com/silverwind/is-cidr) - Check if a string is an IP address in CIDR notation
+- [cidr-regex](https://github.com/silverwind/cidr-regex) - Regular expression for matching IP addresses in CIDR notation