is-odd-ts 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jovan
+
+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,85 @@
+# is-odd-ts
+
+**A strict TypeScript utility to check if a number is odd, with modern type safety and support for edge cases.**
+
+---
+
+Welcome to **`is-odd-ts`**, a lightweight utility for checking if a number is odd, built specifically with strict TypeScript settings. Whether you're working with everyday integers or hitting edge cases like `NaN`, `Infinity`, or very large numbers, this package has you covered.
+
+
+
+## Why use `is-odd-ts`?
+
+- **Type Safety**: Written in TypeScript with the strictest settings, so you get full type safety in your projects.
+- **Handles Edge Cases**: Checks for non-integers, `NaN`, `Infinity`, and numbers beyond JavaScript’s safe integer range.
+- **No Dependencies**: It's small, fast, and doesn’t add bloat to your project.
+- **Modern ESM**: Fully compatible with modern JavaScript (ESM) and TypeScript setups.
+- **Formatted and Linted**: This package is formatted and linted using [Biome.js](https://biomejs.org/), ensuring clean and consistent code.
+
+## Installation
+
+You can install it with `npm`:
+
+```bash
+npm install is-odd-ts
+```
+Or with yarn:
+
+```bash
+yarn add is-odd-ts
+```
+
+## Usage
+
+```typescript
+import { isOdd } from 'is-odd-ts';
+
+console.log(isOdd(1));  // true
+console.log(isOdd(2));  // false
+console.log(isOdd(-3)); // true
+console.log(isOdd(0));  // false
+```
+
+## Common Edge Cases
+
+```typescript
+isOdd(NaN);         // Throws: "Expected a finite number"
+isOdd(Infinity);    // Throws: "Expected a finite number"
+isOdd(-Infinity);   // Throws: "Expected a finite number"
+isOdd(1.5);         // Throws: "Expected an integer"
+isOdd(Number.MAX_SAFE_INTEGER);  // true
+isOdd(Number.MIN_SAFE_INTEGER);  // true
+```
+
+## Features
+
+- ***Zero and Negative Zero***: Both return false (since zero is even).
+- ***Floats***: Throws an error if you try passing in a float.
+- ***`Infinity` & `NaN`***: Throws errors for invalid inputs like `NaN`, `Infinity`, and -`Infinity`.
+- ***Handles large numbers***: Safely checks numbers up to and including JavaScript’s `Number.MAX_SAFE_INTEGER` and `Number.MIN_SAFE_INTEGER`.
+  
+## Testing & Reliability
+I've put effort into testing this utility across a variety of scenarios to make sure it behaves consistently and handles edge cases properly. The tests cover:
+
+- Regular odd and even integers (both positive and negative).
+- Handling of zero and negative zero.
+- Large numbers, including `Number.MAX_SAFE_INTEGER` and `Number.MIN_SAFE_INTEGER``.
+- Proper error handling for invalid inputs like `NaN`, `Infinity`, floats, and values beyond safe integer limits.
+
+Tests have been written using Node's native test runner.
+Run the tests locally with:
+
+```bash
+npm run test
+```
+
+## Contributing
+If you find something missing or think the utility could be improved, feel free to contribute. Open an issue or submit a pull request, and let's keep it simple and efficient.
+
+## License
+This project is licensed under the MIT License, so feel free to use it in your own projects.
+
+Links:
+
+- [GitHub Repository](https://github.com/JovanDj/is-odd-ts)
+- [Issue Tracker](https://github.com/JovanDj/is-odd-ts/issues)

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * is-odd-ts <https://github.com/JovanDj/is-odd-ts>
+ *
+ * Copyright (c) 2024, Jovan Djukic.
+ * Released under the MIT License.
+ */
+/**
+ * Checks if a given number is odd.
+ *
+ * This function validates that the input is a finite, safe integer before determining
+ * if it's odd. It works with both positive and negative numbers. If the input is invalid,
+ * such as a float, NaN, Infinity, or a number outside the safe integer range, the function
+ * throws an appropriate error.
+ *
+ * @param {number} num - The number to check if it's odd.
+ * @returns {boolean} - Returns `true` if the number is odd, `false` if it's even.
+ * @throws {TypeError} - Throws if the input is not a finite number.
+ * @throws {Error} - Throws if the input is not an integer or exceeds the safe integer limit.
+ */
+export declare const isOdd: (num: number) => boolean;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,KAAK,QAAS,MAAM,KAAG,OAcnC,CAAC"}

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+/*!
+ * is-odd-ts <https://github.com/JovanDj/is-odd-ts>
+ *
+ * Copyright (c) 2024, Jovan Djukic.
+ * Released under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOdd = void 0;
+/**
+ * Checks if a given number is odd.
+ *
+ * This function validates that the input is a finite, safe integer before determining
+ * if it's odd. It works with both positive and negative numbers. If the input is invalid,
+ * such as a float, NaN, Infinity, or a number outside the safe integer range, the function
+ * throws an appropriate error.
+ *
+ * @param {number} num - The number to check if it's odd.
+ * @returns {boolean} - Returns `true` if the number is odd, `false` if it's even.
+ * @throws {TypeError} - Throws if the input is not a finite number.
+ * @throws {Error} - Throws if the input is not an integer or exceeds the safe integer limit.
+ */
+const isOdd = (num) => {
+    if (!Number.isFinite(num)) {
+        throw new TypeError("Expected a finite number");
+    }
+    if (!Number.isInteger(num)) {
+        throw new Error("Expected an integer");
+    }
+    if (!Number.isSafeInteger(num)) {
+        throw new Error("Value exceeds maximum safe integer");
+    }
+    return num % 2 !== 0;
+};
+exports.isOdd = isOdd;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;;;;;;;;;;GAYG;AACI,MAAM,KAAK,GAAG,CAAC,GAAW,EAAW,EAAE;IAC7C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,SAAS,CAAC,0BAA0B,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACvD,CAAC;IAED,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;AACtB,CAAC,CAAC;AAdW,QAAA,KAAK,SAchB"}

package/dist/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}

package/dist/index.test.js

@@ -0,0 +1,88 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_test_1 = require("node:test");
+const index_js_1 = require("./index.js");
+(0, node_test_1.test)("isOdd function with integers", async (t) => {
+    await t.test("should return true when the input is an odd positive integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(1), true);
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(3), true);
+    });
+    await t.test("should return true when the input is an odd negative integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-1), true);
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-3), true);
+    });
+    await t.test("should return false when the input is an even positive integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(2), false);
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(4), false);
+    });
+    await t.test("should return false when the input is an even negative integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-2), false);
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-4), false);
+    });
+    await t.test("should return false when the input is zero", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(0), false);
+    });
+    await t.test("should return false when the input is negative zero", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-0), false);
+    });
+    await t.test("should throw an error when the input is a positive float", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(1.5), {
+            message: "Expected an integer",
+        });
+    });
+    await t.test("should throw an error when the input is a negative float", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(-1.5), {
+            message: "Expected an integer",
+        });
+    });
+});
+(0, node_test_1.test)("isOdd function with special constants and edge cases", async (t) => {
+    await t.test("should throw an error when the input is NaN", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(Number.NaN), {
+            message: "Expected a finite number",
+        });
+    });
+    await t.test("should throw an error when the input is Infinity", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(Number.POSITIVE_INFINITY), {
+            message: "Expected a finite number",
+        });
+    });
+    await t.test("should throw an error when the input is -Infinity", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(Number.NEGATIVE_INFINITY), {
+            message: "Expected a finite number",
+        });
+    });
+    await t.test("should return true when the input is Number.MAX_SAFE_INTEGER (positive)", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(Number.MAX_SAFE_INTEGER), true);
+    });
+    await t.test("should return false when the input is the largest even safe integer (positive)", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(Number.MAX_SAFE_INTEGER - 1), false);
+    });
+    await t.test("should return true when the input is Number.MIN_SAFE_INTEGER (negative)", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(Number.MIN_SAFE_INTEGER), true);
+    });
+    await t.test("should return false when the input is the smallest even integer below MIN_SAFE_INTEGER", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(Number.MIN_SAFE_INTEGER + 1), false);
+    });
+    await t.test("should throw an error when the input is exactly one more than Number.MAX_SAFE_INTEGER", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(Number.MAX_SAFE_INTEGER + 1), {
+            message: "Value exceeds maximum safe integer",
+        });
+    });
+    await t.test("should throw an error when the input is exactly one less than Number.MIN_SAFE_INTEGER", () => {
+        strict_1.default.throws(() => (0, index_js_1.isOdd)(Number.MIN_SAFE_INTEGER - 1), {
+            message: "Value exceeds maximum safe integer",
+        });
+    });
+    await t.test("should return false when the input is a large even negative integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-9007199254740990), false);
+    });
+    await t.test("should return true when the input is a large odd negative integer", () => {
+        strict_1.default.strictEqual((0, index_js_1.isOdd)(-9007199254740991), true);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;;;;AAAA,gEAAwC;AACxC,yCAAiC;AAEjC,yCAAmC;AAEnC,IAAA,gBAAI,EAAC,8BAA8B,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAChD,MAAM,CAAC,CAAC,IAAI,CACX,8DAA8D,EAC9D,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACnC,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,8DAA8D,EAC9D,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACpC,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,gEAAgE,EAChE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACpC,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,gEAAgE,EAChE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QACrC,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAC/D,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,CAAC,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QACxE,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,CAAC,IAAI,CACX,0DAA0D,EAC1D,GAAG,EAAE;QACJ,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,GAAG,CAAC,EAAE;YAC/B,OAAO,EAAE,qBAAqB;SAC9B,CAAC,CAAC;IACJ,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,0DAA0D,EAC1D,GAAG,EAAE;QACJ,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,CAAC,GAAG,CAAC,EAAE;YAChC,OAAO,EAAE,qBAAqB;SAC9B,CAAC,CAAC;IACJ,CAAC,CACD,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,IAAA,gBAAI,EAAC,sDAAsD,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IACxE,MAAM,CAAC,CAAC,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;QAChE,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YACtC,OAAO,EAAE,0BAA0B;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,CAAC,IAAI,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACrE,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE;YACpD,OAAO,EAAE,0BAA0B;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,CAAC,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACtE,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE;YACpD,OAAO,EAAE,0BAA0B;SACnC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,CAAC,IAAI,CACX,yEAAyE,EACzE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,gFAAgF,EAChF,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,yEAAyE,EACzE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,wFAAwF,EACxF,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/D,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,uFAAuF,EACvF,GAAG,EAAE;QACJ,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAC,EAAE;YACvD,OAAO,EAAE,oCAAoC;SAC7C,CAAC,CAAC;IACJ,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,uFAAuF,EACvF,GAAG,EAAE;QACJ,gBAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,gBAAK,EAAC,MAAM,CAAC,gBAAgB,GAAG,CAAC,CAAC,EAAE;YACvD,OAAO,EAAE,oCAAoC;SAC7C,CAAC,CAAC;IACJ,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,qEAAqE,EACrE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,CAAC,IAAI,CACX,mEAAmE,EACnE,GAAG,EAAE;QACJ,gBAAM,CAAC,WAAW,CAAC,IAAA,gBAAK,EAAC,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC,CACD,CAAC;AACH,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "is-odd-ts",
+  "version": "1.0.1",
+  "description": "A strict TypeScript-only utility to check if a number is odd, with modern type safety.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check --write",
+    "lint:fix": "biome check --unsafe --write",
+    "test": "npm run build && node --test dist"
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JovanDj/is-odd-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/JovanDj/is-odd-ts/issues"
+  },
+  "homepage": "https://github.com/JovanDj/is-odd-ts#readme",
+  "keywords": [
+    "odd",
+    "is-odd",
+    "number",
+    "typescript",
+    "ts",
+    "strict",
+    "type-safe",
+    "utility",
+    "ESM",
+    "modern-js"
+  ],
+  "author": {
+    "name": "Jovan Djukic",
+    "email": "jovandjukic2@gmail.com",
+    "url": "https://jovandjukic.com"
+  },
+  "license": "MIT",
+  "volta": {
+    "node": "20.17.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.2",
+    "@tsconfig/node20": "^20.1.4",
+    "@tsconfig/recommended": "^1.0.7",
+    "@tsconfig/strictest": "^2.0.5",
+    "@types/node": "^22.7.4",
+    "typescript": "^5.6.2"
+  }
+}