@rohank/ts-utils 0.1.0

package/README.md

@@ -0,0 +1,23 @@
+# TS-Utils - TypeScript Utilities
+**Author:** Rohan Khayech
+
+TS-Utils provides a collection of utility functions and types to simplify common TypeScript patterns.
+
+## Features
+
+### Array Utilities
+- **`filterDistinct<T>(array, key?):`** Filters an array to only include distinct elements.
+
+### Type Guards
+- **`isNonEmptyArray<T>(value):`** Checks if a value is a valid array with `length > 0`.
+- **`isObject<T>(value):`** Returns whether a value is a defined, non-null object.
+- **`isPresent<T>(value):`** Returns whether a value is defined and non-null.
+
+### Type Utilities
+- **`Mutable<T>:`** Makes all properties in type `T` mutable.
+- **`Unknown<T>:`** Represents a valid, non-nullish object with properties of `T` as `unknown`.
+
+## License and Copyright
+Copyright © 2026 Rohan Khayech
+
+TS-Utils is licensed under the [MIT license](LICENSE).

package/dist/Mutable.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Utility type that makes all properties in type `T` mutable.
+ *
+ * This should be only be used while building an object
+ * that should be treated as immutable once returned.
+ *
+ * This should not be used to modify an immutable type received
+ * externally, as often this will not have the intended effect.
+ *
+ * @author Rohan Khayech
+ */
+export type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+//# sourceMappingURL=Mutable.d.ts.map

package/dist/Mutable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mutable.d.ts","sourceRoot":"","sources":["../src/Mutable.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACrB,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACjC,CAAA"}

package/dist/Mutable.js

@@ -0,0 +1,3 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/Unknown.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Utility type representing a valid, non-nullish object.
+ * This object may contain a partial set of the properties of `T` as `unknown` type.
+ *
+ * Used to model unchecked JSON data from an external source (eg. API responses, database documents).
+ * that may be of the correct format or may not.
+ *
+ * Allows typesafe querying of all potential properties, unlike `unknown` or `object`.
+ 
+ * @template T The expected object type.
+ *
+ * @author Rohan Khayech
+ */
+export type Unknown<T> = {
+    [K in keyof T]?: unknown;
+};
+//# sourceMappingURL=Unknown.d.ts.map

package/dist/Unknown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Unknown.d.ts","sourceRoot":"","sources":["../src/Unknown.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO;CAC3B,CAAA"}

package/dist/Unknown.js

@@ -0,0 +1,3 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/filterDistinct.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Filters the specified array to only include elements with distinct keys.
+ *
+ * @param array The array to filter.
+ * @param key A function that returns a key given an element.
+ * @returns A copy of the specified array that only contains the first element with each unique key.
+ *
+ * @author Rohan Khayech
+ */
+export declare function filterDistinct<T>(array: T[], key?: (element: T) => any): T[];
+//# sourceMappingURL=filterDistinct.d.ts.map

package/dist/filterDistinct.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterDistinct.d.ts","sourceRoot":"","sources":["../src/filterDistinct.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC5B,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,GAAE,CAAC,OAAO,EAAE,CAAC,KAAK,GAA0B,GAChD,CAAC,EAAE,CAUL"}

package/dist/filterDistinct.js

@@ -0,0 +1,26 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterDistinct = filterDistinct;
+/**
+ * Filters the specified array to only include elements with distinct keys.
+ *
+ * @param array The array to filter.
+ * @param key A function that returns a key given an element.
+ * @returns A copy of the specified array that only contains the first element with each unique key.
+ *
+ * @author Rohan Khayech
+ */
+function filterDistinct(array, key) {
+    if (key === void 0) { key = function (element) { return element; }; }
+    var seen = new Set();
+    return array.filter(function (e) {
+        if (seen.has(key(e))) {
+            return false;
+        }
+        else {
+            seen.add(key(e));
+            return true;
+        }
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Utility functions and types.
+ * @author Rohan Khayech
+ */
+export * from "./filterDistinct";
+export * from "./isNonEmptyArray";
+export * from "./isObject";
+export * from "./isPresent";
+export * from "./Mutable";
+export * from "./Unknown";
+//# 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":"AAEA;;;GAGG;AAEH,cAAc,kBAAkB,CAAA;AAChC,cAAc,mBAAmB,CAAA;AACjC,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA"}

package/dist/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Utility functions and types.
+ * @author Rohan Khayech
+ */
+__exportStar(require("./filterDistinct"), exports);
+__exportStar(require("./isNonEmptyArray"), exports);
+__exportStar(require("./isObject"), exports);
+__exportStar(require("./isPresent"), exports);
+__exportStar(require("./Mutable"), exports);
+__exportStar(require("./Unknown"), exports);

package/dist/isNonEmptyArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if the given value is a valid, non empty array.
+ * @param value The value to check.
+ * @returns `true` if the value is a valid array (using `Array.isArray()`) with `length > 0`, `false` otherwise.
+ * @author Rohan Khayech
+ */
+export declare function isNonEmptyArray<T = unknown>(value: T[] | unknown): value is T[];
+//# sourceMappingURL=isNonEmptyArray.d.ts.map

package/dist/isNonEmptyArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNonEmptyArray.d.ts","sourceRoot":"","sources":["../src/isNonEmptyArray.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,GAAG,OAAO,EACvC,KAAK,EAAE,CAAC,EAAE,GAAG,OAAO,GACrB,KAAK,IAAI,CAAC,EAAE,CAEd"}

package/dist/isNonEmptyArray.js

@@ -0,0 +1,13 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNonEmptyArray = isNonEmptyArray;
+/**
+ * Checks if the given value is a valid, non empty array.
+ * @param value The value to check.
+ * @returns `true` if the value is a valid array (using `Array.isArray()`) with `length > 0`, `false` otherwise.
+ * @author Rohan Khayech
+ */
+function isNonEmptyArray(value) {
+    return Array.isArray(value) && value.length > 0;
+}

package/dist/isObject.d.ts

@@ -0,0 +1,8 @@
+import { Unknown } from "./Unknown";
+/**
+ * Returns whether the value is a defined, non-null object.
+ * @param value The value to check and return.
+ * @author Rohan Khayech
+ */
+export declare function isObject<T = Record<string, unknown>>(value: unknown): value is Unknown<T>;
+//# sourceMappingURL=isObject.d.ts.map

package/dist/isObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isObject.d.ts","sourceRoot":"","sources":["../src/isObject.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChD,KAAK,EAAE,OAAO,GACf,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAErB"}

package/dist/isObject.js

@@ -0,0 +1,12 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+/**
+ * Returns whether the value is a defined, non-null object.
+ * @param value The value to check and return.
+ * @author Rohan Khayech
+ */
+function isObject(value) {
+    return value !== null && typeof value === "object";
+}

package/dist/isPresent.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns whether the value is defined and non-null.
+ * @param value The value to check and return.
+ * @author Rohan Khayech
+ */
+export declare function isPresent<T>(value: T): value is NonNullable<T>;
+//# sourceMappingURL=isPresent.d.ts.map

package/dist/isPresent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPresent.d.ts","sourceRoot":"","sources":["../src/isPresent.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CAE9D"}

package/dist/isPresent.js

@@ -0,0 +1,12 @@
+"use strict";
+/* Copyright (c) 2026 Rohan Khayech */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPresent = isPresent;
+/**
+ * Returns whether the value is defined and non-null.
+ * @param value The value to check and return.
+ * @author Rohan Khayech
+ */
+function isPresent(value) {
+    return value !== undefined && value !== null;
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@rohank/ts-utils",
+  "version": "0.1.0",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "scripts": {
+    "lint": "eslint --ext .js,.ts .",
+    "lint:fix": "eslint --ext .js,.ts . --fix",
+    "test": "jest --verbose",
+    "build": "tsc",
+    "clean": "rimraf dist"
+  },
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^30.2.0",
+    "prettier": "^3.8.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.7.3"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "roots": [
+      "./test"
+    ]
+  },
+  "description": "Collection of utility functions and types to simplify common TypeScript patterns.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rohankhayech/TSUtils.git"
+  },
+  "keywords": [
+    "typescript",
+    "utilities"
+  ],
+  "author": "Rohan Khayech",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rohankhayech/TSUtils/issues"
+  },
+  "homepage": "https://github.com/rohankhayech/TSUtils#readme"
+}