@tsed/core 8.18.1 → 8.19.0

package/lib/types/utils/isBoolean.d.ts

@@ -1,7 +1,14 @@
 /**
+ * Checks if a value is a boolean primitive.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export declare function isBoolean(target: any): target is boolean;
+/**
+ * Checks if a value is a boolean primitive, Boolean object, or the Boolean constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isBooleanOrBooleanClass(target: any): target is boolean;

package/lib/types/utils/isBuffer.d.ts

@@ -1,9 +1,14 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 /**
- * Tests to see if the object is Buffer
- * @param target
- * @returns {boolean}
+ * Checks if a value is a Buffer or Uint8Array instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isBuffer(target: any): target is Buffer;
+/**
+ * Checks if a value is the Uint8Array constructor or a Uint8Array instance.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isUint8Array(target: any): target is Uint8Array;

package/lib/types/utils/isClass.d.ts

@@ -1 +1,10 @@
+/**
+ * Determines whether a given value represents a class (constructor function).
+ *
+ * This helper filters out common non-class values such as primitives, symbols,
+ * plain objects, dates, promises, arrays, buffers, and arrow functions.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isClass(target: any): boolean;

package/lib/types/utils/isCollection.d.ts

@@ -1,6 +1,9 @@
 /**
- * Return true if the target.
- * @param target
- * @returns {boolean}
+ * Determines whether a value is a collection type (Array, Map, Set, WeakMap, WeakSet).
+ *
+ * Checks both the constructor itself and instances of these collection types.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isCollection(target: any): boolean;

package/lib/types/utils/isDate.d.ts

@@ -1,6 +1,7 @@
 /**
+ * Checks if a value is the Date constructor or a valid Date instance.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export declare function isDate(target: any): target is Date;

package/lib/types/utils/isEmpty.d.ts

@@ -1,6 +1,7 @@
 /**
- * Return true if the value is an empty string, null or undefined.
- * @param value
- * @returns {boolean}
+ * Checks if a value is an empty string, null, or undefined.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isEmpty(value: any): boolean;

package/lib/types/utils/isEnumerable.d.ts

@@ -1,6 +1,7 @@
 /**
+ * Checks if a property is enumerable on an object, considering its prototype chain.
  *
- * @param obj
- * @param key
+ * @public
+ * @since v7.0.0
  */
 export declare function isEnumerable(obj: any, key: string): any;

package/lib/types/utils/isFunction.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if a value is a function.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isFunction(target: any): target is Function;

package/lib/types/utils/isInheritedFrom.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if a target class inherits from another class within a specified depth limit.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isInheritedFrom(target: any, from: any, deep?: number): boolean;

package/lib/types/utils/isMomentObject.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if an object is a Moment.js object by verifying the _isAMomentObject property.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isMomentObject(obj: any): boolean;

package/lib/types/utils/isMongooseObject.d.ts

@@ -1,2 +1,14 @@
-export declare function isObjectID(obj: any): any;
+/**
+ * Checks if an object is a MongoDB ObjectID by verifying the _bsontype property.
+ *
+ * @public
+ * @since v7.0.0
+ */
+export declare function isObjectID(obj: any): boolean;
+/**
+ * Checks if an object is a Mongoose model or MongoDB ObjectID.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isMongooseObject(obj: any): boolean;

package/lib/types/utils/isNil.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if a value is null or undefined.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isNil(value: any): boolean;

package/lib/types/utils/isNumber.d.ts

@@ -1,7 +1,14 @@
 /**
+ * Checks if a value is a number primitive.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export declare function isNumber(target: any): target is number;
+/**
+ * Checks if a value is a number primitive, Number object, or the Number constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isNumberOrNumberClass(target: any): target is number;

package/lib/types/utils/isObject.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if a value is an object type.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isObject(target: any): target is object;

package/lib/types/utils/isObservable.d.ts

@@ -1 +1,8 @@
-export declare function isObservable<T>(obj: any): boolean;
+import type { Observable } from "rxjs";
+/**
+ * Checks if an object is an RxJS Observable by verifying lift and subscribe methods.
+ *
+ * @public
+ * @since v7.0.0
+ */
+export declare function isObservable<T>(obj: any): obj is Observable<T>;

package/lib/types/utils/isPlainObject.d.ts

@@ -1,7 +1,14 @@
 /**
+ * Checks if a value is the Object constructor.
  *
- * @param target
- * @returns {boolean}
+ * @public
+ * @since v7.0.0
  */
 export declare function isClassObject(target: any): target is Object;
+/**
+ * Checks if a value is a plain object (not a class instance or constructor).
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isPlainObject(target: any): boolean;

package/lib/types/utils/isPrimitive.d.ts

@@ -1,14 +1,21 @@
 /**
- * Return true if the given obj is a primitive.
- * @param target
- * @returns {boolean}
- * @ignore
+ * Checks if a value is a primitive or primitive class constructor (String, Number, Boolean).
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isPrimitiveOrPrimitiveClass(target: any): boolean;
 /**
- * Return true if the given obj is a primitive.
- * @param target
- * @returns {boolean}
+ * Checks if a value is a primitive type (string, number, or boolean).
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isPrimitive(target: any): boolean;
+/**
+ * Checks if a value is a primitive class constructor (String, Number, or Boolean).
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isPrimitiveClass(target: any): boolean;

package/lib/types/utils/isPromise.d.ts

@@ -1,7 +1,8 @@
 /**
- * Tests to see if the object is an ES2015 (ES6) Promise
+ * Checks if a value is a Promise by verifying the then method exists and it's not an Observable.
+ *
+ * @public
+ * @since v7.0.0
  * @see {@link https://www.ecma-international.org/ecma-262/6.0/#sec-promise-objects}
- * @param target
- * @returns {boolean}
  */
 export declare function isPromise<T = any>(target: any): target is Promise<T>;

package/lib/types/utils/isProtectedKey.d.ts

@@ -1,5 +1,7 @@
 /**
- * Prevent prototype pollution vulnerability
- * @param key
+ * Checks if a key is a protected property name to prevent prototype pollution vulnerabilities.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isProtectedKey(key: string): boolean;

package/lib/types/utils/isRegExp.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if a value is a RegExp instance.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isRegExp(target: any): target is RegExp;

package/lib/types/utils/isSerializable.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if data requires serialization by excluding buffers, streams, and primitive types.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isSerializable(data: any): boolean;

package/lib/types/utils/isStream.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if an object is a Node.js stream by verifying the pipe method exists.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isStream(obj: any): boolean;

package/lib/types/utils/isString.d.ts

@@ -1,6 +1,14 @@
 /**
- * @param target
- * @returns {boolean}
+ * Checks if a value is a string primitive.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function isString(target: any): target is string;
+/**
+ * Checks if a value is a string primitive, String object, or the String constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isStringOrStringClass(target: any): target is string;

package/lib/types/utils/isSymbol.d.ts

@@ -1,6 +1,14 @@
 /**
+ * Checks if a value is a symbol primitive.
  *
- * @param target
+ * @public
+ * @since v7.0.0
  */
 export declare function isSymbol(target: any): target is symbol;
+/**
+ * Checks if a value is a symbol primitive, Symbol object, or the Symbol constructor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function isSymbolOrSymbolClass(target: any): target is symbol;

package/lib/types/utils/methodsOf.d.ts

@@ -1,7 +1,9 @@
 import type { Type } from "../types/Type.js";
 /**
- * Return all methods for a given class.
- * @param target
+ * Returns all methods for a given class by traversing its prototype chain.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function methodsOf(target: any): {
     target: Type;

package/lib/types/utils/nameOf.d.ts

@@ -1,14 +1,21 @@
 /**
- * Get the provide name.
- * @param targetClass
+ * Gets the name of a class from a constructor function or instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function nameOfClass(targetClass: any): string;
 /**
- * Get symbol name.
- * @param sym
+ * Extracts the name from a symbol by removing the Symbol() wrapper.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare const nameOfSymbol: (sym: symbol) => string;
 /**
- * Get object name
+ * Gets the name of any object including symbols, functions, and classes.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function nameOf(obj: any): string;

package/lib/types/utils/objectKeys.d.ts

@@ -1 +1,7 @@
+/**
+ * Returns object keys excluding protected keys like constructor and prototype.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function objectKeys(obj: any): string[];

package/lib/types/utils/primitiveOf.d.ts

@@ -1 +1,7 @@
+/**
+ * Determines the primitive type name for a given target value or class.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function primitiveOf(target: any): "string" | "number" | "boolean" | "any";

package/lib/types/utils/prototypeOf.d.ts

@@ -1,6 +1,7 @@
 /**
- * Return the prototype of the given class.
- * @param target
- * @returns {any}
+ * Returns the prototype of a given class or instance.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function prototypeOf(target: any): any;

package/lib/types/utils/setValue.d.ts

@@ -1 +1,21 @@
+/**
+ * Sets a value on an object using a dot-notation expression path.
+ *
+ * Supports both plain objects and Map-like objects (with `.set()`, `.get()`, `.has()` methods).
+ * Automatically creates intermediate objects as needed. Protected keys (`__proto__`, `constructor`, `prototype`) are ignored for security.
+ *
+ * ```typescript
+ * const obj = {};
+ * setValue(obj, "user.name", "John");
+ * // obj is now { user: { name: "John" } }
+ * ```
+ *
+ * @param scope - The target object or Map to set the value on
+ * @param expression - Dot-notation path to the property (e.g., "user.profile.name")
+ * @param value - The value to set at the specified path
+ * @param separator - Path separator character (default: ".")
+ * @returns void
+ * @public
+ * @since v7.0.0
+ */
 export declare function setValue(scope: any, expression: string, value: any, separator?: string): void;

package/lib/types/utils/toMap.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Callback function type for generating map keys from items.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export type ToMapIdentityCB<V> = (item: V, index: string | number) => string | string[];
+/**
+ * Identity type for map key generation, either a property name or callback function.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export type ToMapIdentity<V> = string | ToMapIdentityCB<V>;
+/**
+ * Converts an array or object to a Map using a key extraction strategy.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function toMap<K extends keyof any = any, V = any>(input: Record<K, V> | V[], keyOrFn?: ToMapIdentity<V>): Map<K, V>;

package/lib/types/utils/toStringConstructor.d.ts

@@ -1 +1,11 @@
+/**
+ * Returns the textual signature of a class/instance constructor.
+ *
+ * Example output: `constructor(id: string, name?: string)`.
+ * Useful for debugging and documentation generation.
+ *
+ * @param target Instance or constructor.
+ * @returns The constructor signature as a string.
+ * @public
+ */
 export declare function toStringConstructor(target: any): string;

package/lib/types/utils/uniq.d.ts

@@ -1,5 +1,14 @@
 /**
- * @param list
+ * Returns a new array with duplicate values removed.
+ *
+ * @public
+ * @since v7.0.0
  */
 export declare function uniq<T = any>(list: T[]): T[];
+/**
+ * Returns a new array with duplicate objects removed based on a specified property key.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function uniqBy<T = any>(list: T[], key?: string): T[];

package/lib/types/utils/useDecorators.d.ts

@@ -1,2 +1,8 @@
 import { AnyDecorator } from "../types/AnyDecorator.js";
+/**
+ * Combines multiple decorators into a single decorator function.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function useDecorators(...decorators: AnyDecorator[]): any;

package/lib/types/utils/useMethodDecorators.d.ts

@@ -1,3 +1,15 @@
 import { AnyDecorator } from "../types/AnyDecorator.js";
+/**
+ * Wraps a decorator to ensure it receives the proper method descriptor.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function useMethodDecorator(decorator: AnyDecorator): (target: any, propertyKey: string | symbol) => any;
+/**
+ * Combines multiple method decorators into a single decorator with proper descriptor handling.
+ *
+ * @public
+ * @since v7.0.0
+ */
 export declare function useMethodDecorators(...decorators: AnyDecorator[]): (target: any, propertyKey: string | symbol) => void;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/core",
   "description": "Core module for Ts.ED Framework",
   "type": "module",
-  "version": "8.18.1",
+  "version": "8.19.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -39,11 +39,11 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.18.1",
+    "@tsed/barrels": "8.19.0",
     "@tsed/monorepo-utils": "3.0.0",
-    "@tsed/typescript": "8.18.1",
-    "@tsed/vitest": "8.18.1",
-    "typescript": "5.4.5",
+    "@tsed/typescript": "8.19.0",
+    "@tsed/vitest": "8.19.0",
+    "typescript": "5.9.3",
     "vitest": "3.2.4"
   },
   "peerDependencies": {},