tiny-essentials 1.28.1 → 1.28.3

package/dist/v1/libs/UltraRandomMsgGen.d.mts

@@ -1,22 +1,5 @@
-export default UltraRandomMsgGen;
-/**
- * Defines how the message content is generated:
- * - `mixed`: Combines readable words, gibberish, symbols, emojis, etc.
- * - `readable`: Focuses on human-readable words only.
- * - `chaotic`: Pure chaos, mostly gibberish and symbols.
- * - `natural`: Uses structured grammar templates to form silly but proper sentences.
- */
-export type RandomMsgModes = "mixed" | "readable" | "chaotic" | "natural";
-/**
- * Controls where emojis are placed:
- * - `inline`: Emojis may appear throughout the text.
- * - `end`: Emojis appear at the end of lines.
- * - `none`: No emojis will be used.
- */
-export type EmojiPlacement = "inline" | "end" | "none";
-/**
- * Configuration object for customizing message generation.
- */
+export type RandomMsgModes = 'mixed' | 'readable' | 'chaotic' | 'natural';
+export type EmojiPlacement = 'inline' | 'end' | 'none';
 export type MsgGenConfig = {
     /**
      * - Minimum total length (in characters) of the final generated text.
@@ -79,15 +62,9 @@ export type MsgGenConfig = {
      * - Optional paragraph configuration.
      */
     paragraphs?: {
-        /**
-         * - Minimum number of paragraphs to generate.
-         */
         min: number;
-        /**
-         * - Maximum number of paragraphs to generate.
-         */
         max: number;
-    } | undefined;
+    };
     /**
      * - Configuration for line-based generation.
      */
@@ -159,48 +136,39 @@ export type MsgGenConfig = {
  * @class
  */
 declare class UltraRandomMsgGen {
-    /** @type {string[]} */
-    static #defaultWords: string[];
-    /** @type {string[]} */
-    static #defaultEmojis: string[];
-    /** @type {string[]} */
-    static #defaultNouns: string[];
-    /** @type {string[]} */
-    static #defaultVerbs: string[];
-    /** @type {string[]} */
-    static #defaultAdjectives: string[];
-    /** @type {string[]} */
-    static #defaultTemplates: string[];
-    /**
-     * Utility to validate arrays before setting.
-     * @param {any} value
-     * @param {string} field
-     */
-    static #validateArray(value: any, field: string): void;
-    /** @param {string[]} value */
-    static set defaultWords(value: string[]);
+    #private;
     /** @returns {string[]} */
     static get defaultWords(): string[];
     /** @param {string[]} value */
-    static set defaultEmojis(value: string[]);
+    static set defaultWords(value: string[]);
     /** @returns {string[]} */
     static get defaultEmojis(): string[];
     /** @param {string[]} value */
-    static set defaultNouns(value: string[]);
+    static set defaultEmojis(value: string[]);
     /** @returns {string[]} */
     static get defaultNouns(): string[];
     /** @param {string[]} value */
-    static set defaultVerbs(value: string[]);
+    static set defaultNouns(value: string[]);
     /** @returns {string[]} */
     static get defaultVerbs(): string[];
     /** @param {string[]} value */
-    static set defaultAdjectives(value: string[]);
+    static set defaultVerbs(value: string[]);
     /** @returns {string[]} */
     static get defaultAdjectives(): string[];
     /** @param {string[]} value */
-    static set defaultTemplates(value: string[]);
+    static set defaultAdjectives(value: string[]);
     /** @returns {string[]} */
     static get defaultTemplates(): string[];
+    /** @param {string[]} value */
+    static set defaultTemplates(value: string[]);
+    /**
+     * Gets the current destruction status of the instance.
+     *
+     * @returns {boolean} True if the instance is destroyed, false otherwise.
+     */
+    get destroyed(): boolean;
+    get config(): MsgGenConfig;
+    get symbols(): string[];
     /**
      * Creates an instance of UltraRandomMsgGen.
      *
@@ -231,42 +199,34 @@ declare class UltraRandomMsgGen {
      * @param {number} [config.line.emojiChance=0.3] - Probability (0–1) of placing emoji per line.
      */
     constructor(config?: {
-        minLength?: number | undefined;
-        maxLength?: number | undefined;
-        readable?: boolean | undefined;
-        useEmojis?: boolean | undefined;
-        includeNumbers?: boolean | undefined;
-        includeSymbols?: boolean | undefined;
-        allowWeirdSpacing?: boolean | undefined;
-        emojiSet?: string[] | undefined;
-        wordSet?: string[] | undefined;
-        mode?: RandomMsgModes | undefined;
+        minLength?: number;
+        maxLength?: number;
+        readable?: boolean;
+        useEmojis?: boolean;
+        includeNumbers?: boolean;
+        includeSymbols?: boolean;
+        allowWeirdSpacing?: boolean;
+        emojiSet?: string[];
+        wordSet?: string[];
+        mode?: RandomMsgModes;
         grammar?: {
-            templates?: string[] | undefined;
-            nouns?: string[] | undefined;
-            verbs?: string[] | undefined;
-            adjectives?: string[] | undefined;
-        } | undefined;
-        repeatWords?: boolean | undefined;
-        emojiPlacement?: EmojiPlacement | undefined;
+            templates?: string[];
+            nouns?: string[];
+            verbs?: string[];
+            adjectives?: string[];
+        };
+        repeatWords?: boolean;
+        emojiPlacement?: EmojiPlacement;
         paragraphs?: {
-            min?: number | undefined;
-            max?: number | undefined;
-        } | undefined;
+            min?: number;
+            max?: number;
+        };
         line?: {
-            minLength?: number | undefined;
-            maxLength?: number | undefined;
-            emojiChance?: number | undefined;
-        } | undefined;
+            minLength?: number;
+            maxLength?: number;
+            emojiChance?: number;
+        };
     });
-    /**
-     * Gets the current destruction status of the instance.
-     *
-     * @returns {boolean} True if the instance is destroyed, false otherwise.
-     */
-    get destroyed(): boolean;
-    get config(): MsgGenConfig;
-    get symbols(): string[];
     /**
      * Merges new configuration values into the current instance.
      * @param {Object} newConfig - Object with one or more configuration overrides.
@@ -429,6 +389,6 @@ declare class UltraRandomMsgGen {
      * @returns {void}
      */
     destroy(): void;
-    #private;
 }
+export default UltraRandomMsgGen;
 //# sourceMappingURL=UltraRandomMsgGen.d.mts.map

package/dist/v1/libs/utils.d.mts

@@ -1,2 +1,6 @@
-export function createCheckDestroyed(name: string): (isDestroyed: boolean) => void;
+/**
+ * Creates a internal method to verify if the instance was been destroyed.
+ * @param {string} name
+ */
+export declare const createCheckDestroyed: (name: string) => (isDestroyed: boolean) => void;
 //# sourceMappingURL=utils.d.mts.map

package/docs/v1/basics/deprecated/objFilter.md

@@ -0,0 +1,14 @@
+### 🔍 `objType(obj, [type])`
+
+Get the type of any value, or check it against a known type.
+
+```js
+objType([], 'array'); // true
+objType('hello');     // "string"
+objType(undefined);   // null
+```
+
+Returns:
+- `true` / `false` if a type is provided
+- The detected type name as a string if no type is provided
+- `null` if `undefined` is passed

package/docs/v1/basics/objFilter.md

@@ -23,23 +23,6 @@ Whether you’re validating inputs, writing schema validators, or building tools
 
 ## Usage
 
-### 🔍 `objType(obj, [type])`
-
-Get the type of any value, or check it against a known type.
-
-```js
-objType([], 'array'); // true
-objType('hello');     // "string"
-objType(undefined);   // null
-```
-
-Returns:
-- `true` / `false` if a type is provided
-- The detected type name as a string if no type is provided
-- `null` if `undefined` is passed
-
----
-
 ### 🔍 `checkObj(obj)`
 
 Checks the type of a given object and returns the validation result if a known type is detected.
@@ -73,6 +56,37 @@ Returns:
 
 ---
 
+### 🏷️ `objTypeName(val)`
+
+Returns the detected type name of a given value as a string.
+
+```js
+objTypeName([]); // "array"
+objTypeName(null); // "null"
+objTypeName(new Set()); // "set"
+```
+
+Returns:
+- A string representing the type name (e.g., `"array"`, `"date"`, `"map"`).
+- `"unknown"` if no matching type is found.
+
+---
+
+### ✅ `isObjType(obj, type)`
+
+Checks whether a given object matches a specific type. This check is case-insensitive.
+
+```js
+isObjType([], 'array'); // true
+isObjType({}, 'object'); // true
+isObjType('hello', 'string'); // true
+isObjType(123, 'boolean'); // false
+```
+
+*Note: Throws a `TypeError` if the `type` argument is not a string.*
+
+---
+
 ### ➕ `extendObjType(newTypes, [index])`
 
 Add your own custom types. You can optionally define where in the check order they go.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.28.1",
+  "version": "1.28.3",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "bin": {
     "tiny-essentials-fork": "./TinyFork.mjs"
@@ -557,7 +557,7 @@
     "sass": "^1.101.0",
     "tslib": "^2.8.1",
     "type-fest": "^5.7.0",
-    "typescript": "^6.0.3",
+    "typescript": "^7.0.2",
     "webpack": "^5.99.6",
     "webpack-cli": "^7.1.0"
   }