@hwycdfatm/is-odd 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 hwycdfatm
+
+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,88 @@
+# @hwycdfatm/is-odd
+
+> Returns true if a number is odd, false if even, null if not implemented yet.
+
+⚠️ **Troll Version** - This is a "work in progress" package that implements odd number checking one number at a time. Currently only supports limited cases. More updates coming soon! 😄
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+npm install @hwycdfatm/is-odd
+```
+
+## Usage
+
+```js
+const isOdd = require('@hwycdfatm/is-odd');
+
+console.log(isOdd(1));  // => true (implemented!)
+console.log(isOdd(2));  // => null (not implemented yet)
+console.log(isOdd(3));  // => null (not implemented yet)
+console.log(isOdd(5));  // => null (not implemented yet)
+```
+
+## Current Status
+
+**Version 0.0.1** - Only the following cases are implemented:
+
+✅ `isOdd(1)` → `true`  
+❌ All other numbers → `null` (not implemented yet)
+
+This package will be updated regularly with more number support. Stay tuned!
+
+## API
+
+### isOdd(number)
+
+Checks if the given number is odd.
+
+**Params**
+
+* `number` **{Number}**: The number to check
+
+**Returns**
+
+* **{Boolean|null}**: 
+  - Returns `true` if the number is odd (when implemented)
+  - Returns `false` if the number is even (when implemented)
+  - Returns `null` if not implemented yet
+  - Throws `TypeError` if input is not a finite number
+
+**Example**
+
+```js
+const isOdd = require('@hwycdfatm/is-odd');
+
+console.log(isOdd(1));        // => true
+console.log(isOdd(3));        // => null
+console.log(isOdd(NaN));      // => throws TypeError
+console.log(isOdd(Infinity)); // => throws TypeError
+```
+
+## TypeScript
+
+This package includes TypeScript definitions.
+
+```typescript
+import isOdd = require('@hwycdfatm/is-odd');
+
+const result = isOdd(1);  // true
+const result2 = isOdd(3); // null
+```
+
+## About
+
+### Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Author
+
+**hwycdfatm**
+
+### License
+
+Copyright © 2026, [hwycdfatm].
+Released under the [MIT License](LICENSE).

package/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns true if the given number is odd, false if even, null if not implemented yet.
+ * 
+ * @param number - The number to check
+ * @returns true if odd (when implemented), false if even (when implemented), null if not implemented yet
+ * @throws {TypeError} If the input is not a finite number
+ */
+declare function isOdd(number: number | string): boolean | null;
+
+export = isOdd;

package/index.js

@@ -0,0 +1,27 @@
+/*!
+ * is-odd <https://github.com/hwycdfatm/is-odd>
+ *
+ * Copyright (c) 2026, HWYCDFATM.
+ * Released under the MIT License.
+ */
+
+'use strict'
+
+/**
+ * Returns true if the given number is odd, false otherwise.
+ *
+ * @param {Number} value
+ * @return {Boolean}
+ * @api public
+ */
+
+module.exports = function isOdd(number) {
+	const num = Number(number)
+	if (!Number.isFinite(num)) {
+		throw new TypeError('Expected a finite number')
+	}
+
+	if (number === 1) return true
+
+	return null
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@hwycdfatm/is-odd",
+	"version": "0.0.1",
+	"description": "Returns true if a number is odd, false if even, null if not implemented yet (troll version - updates coming soon!)",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"scripts": {
+		"test": "node test.js"
+	},
+	"keywords": [
+		"is-odd",
+		"odd",
+		"number",
+		"is",
+		"even",
+		"math",
+		"utility"
+	],
+	"license": "MIT",
+	"author": "hwycdfatm <mai.tritoan7102@gmail.com>",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/hwycdfatm/is-odd.git"
+	},
+	"bugs": {
+		"url": "https://github.com/hwycdfatm/is-odd/issues"
+	},
+	"homepage": "https://github.com/hwycdfatm/is-odd#readme",
+	"engines": {
+		"node": ">=0.10.0"
+	}
+}