@validatem/is-port-number 1.0.0

package/README.md

@@ -0,0 +1,25 @@
+# @validatem/is-port-number
+
+Validates that a given value is a valid port number. This validator is meant to be used with [Validatem](https://validatem.cryto.net/), the universal validation library.
+
+This validator treats all integers between 0 and 65535 (inclusive) as valid port numbers, as these are typically the port numbers accepted by networking APIs. Note that this includes 0 (typically used to indicate 'random port choice') as well as ephemeral port numbers that are typically used for outgoing connections, since these are system-specific behaviours.
+
+## Usage
+
+More extensive usage documentation can be found on the [Validatem website](https://validatem.cryto.net).
+
+```js
+validateValue(value, [ isPortNumber ]);
+```
+
+This validator does not take any options.
+
+## Possible error codes
+
+- __validatem.is-number.number:__ The given value is not a Number type.
+- __validatem.is-integer:__ The given value is not an integer.
+- __validatem.is-port-number:__ The given value is not within the range of valid port numbers.
+
+## License
+
+WTFPL or CC0, at your choice.

package/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+const isInteger = require("@validatem/is-integer");
+const ValidationError = require("@validatem/error");
+
+module.exports = [
+	isInteger,
+	function (value) {
+		if (value < 0 || value > 65535) {
+			throw new ValidationError(`Must be a valid port number between 0 and 65535`, { code: "validatem.is-port-number" });
+		}
+	}
+];

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@validatem/is-port-number",
+  "version": "1.0.0",
+  "description": "Validator for determining whether a value is a valid port number",
+  "main": "index.js",
+  "repository": {
+    "url": "https://codeberg.org/validatem/is-port-number.git"
+  },
+  "keywords": [
+    "validatem",
+    "validation",
+    "port",
+    "network"
+  ],
+  "author": "Sven Slootweg <admin@cryto.net>",
+  "license": "WTFPL OR CC0-1.0",
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "^11.21.0",
+      "onFail": "download"
+    }
+  },
+  "dependencies": {
+    "@validatem/error": "^1.1.0",
+    "@validatem/is-integer": "^0.1.1"
+  },
+  "devDependencies": {
+    "@validatem/core": "^0.6.3"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/test.js

@@ -0,0 +1,32 @@
+"use strict";
+
+const test = require("node:test");
+const assert = require("node:assert");
+const { validateValue } = require("@validatem/core");
+
+const isPortNumber = require(".");
+
+test("valid value", () => {
+	validateValue(5287, [ isPortNumber ]);
+});
+
+test("negative value", () => {
+	assert.throws(
+		() => validateValue(-5287, [ isPortNumber ]),
+		(error) => error.errors[0].code === "validatem.is-port-number"
+	);
+});
+
+test("string value", () => {
+	assert.throws(
+		() => validateValue("5287", [ isPortNumber ]),
+		(error) => error.errors[0].code === "validatem.is-number.number"
+	);
+});
+
+test("float", () => {
+	assert.throws(
+		() => validateValue(5287.42, [ isPortNumber ]),
+		(error) => error.errors[0].code === "validatem.is-integer"
+	);
+});