clear-af.js 1.0.1 → 1.0.3

package/README.md

@@ -4,6 +4,8 @@ A JavaScript package packed with utilities to make your code **readable af**. Be
 
 📖 **Languages** : [🇬🇧 English](#) | [🇫🇷 Français](README_FR.md)
 
+📚 **[Full Documentation](https://froostdev.github.io/clear-af.js/)**
+
 ---
 
 ## 📦 Installation

package/dist/index.d.ts

@@ -6,48 +6,94 @@
 declare function getDate(time?: boolean): string;
 /**
  * Show a pretty error log message with optional date information
+ * @category Logging
  * @function prettyError
  * @param err - Error message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyError("Database connection failed");
+ * // Output: ✕ - Database connection failed (in red)
+ *
+ * prettyError("Critical error", true);
+ * // Output: ✕ [30/03/2026 10:30:45] - Critical error (in red with timestamp)
  */
 declare function prettyError(err: string, time?: boolean): void;
 /**
  * Show a pretty warn log message with optional date information
+ * @category Logging
  * @function prettyWarn
  * @param warn - Warning message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyWarn("Deprecated function used");
+ * // Output: ⚠ - Deprecated function used (in orange)
+ *
+ * prettyWarn("Low memory", true);
+ * // Output: ⚠ [30/03/2026 10:30:45] - Low memory (in orange with timestamp)
  */
 declare function prettyWarn(warn: string, time?: boolean): void;
 /**
  * Show a pretty success log message with optional date information
+ * @category Logging
  * @function prettySuccess
  * @param success - Success message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettySuccess("User created successfully");
+ * // Output: ✔ - User created successfully (in green)
+ *
+ * prettySuccess("Data saved", true);
+ * // Output: ✔ [30/03/2026 10:30:45] - Data saved (in green with timestamp)
  */
 declare function prettySuccess(success: string, time?: boolean): void;
 /**
  * Show a pretty information log message with optional date information
+ * @category Logging
  * @function prettyInfo
  * @param info - Information message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyInfo("Server is running on port 3000");
+ * // Output: ℹ - Server is running on port 3000 (in blue)
+ *
+ * prettyInfo("Cache cleared", true);
+ * // Output: ℹ [30/03/2026 10:30:45] - Cache cleared (in blue with timestamp)
  */
 declare function prettyInfo(info: string, time?: boolean): void;
 /**
  * Show a pretty debug log message with optional date information
+ * @category Logging
  * @function prettyDebug
  * @param debug - Debug message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyDebug("Variable x = 42");
+ * // Output: ⚙ - Variable x = 42 (in white)
+ *
+ * prettyDebug("Function call trace", true);
+ * // Output: ⚙ [30/03/2026 10:30:45] - Function call trace (in white with timestamp)
  */
 declare function prettyDebug(debug: string, time?: boolean): void;
 /**
  * Show a separator line in console
+ * @category Logging
  * @function logSeparator
+ * @example
+ * logSeparator();
+ * // Output: ══════════════════════════════════════════════════
  */
 declare function logSeparator(): void;
 /**
  * Display a header with a title in the center
+ * @category Logging
  * @function logHeader
  * @param title - The title of the header
+ * @example
+ * logHeader("Welcome");
+ * // Output:
+ * // ╔═════════╗
+ * // ║ Welcome ║
+ * // ╚═════════╝
  */
 declare function logHeader(title: string): void;
 /**
@@ -57,31 +103,58 @@ declare function logHeader(title: string): void;
  */
 /**
  * Check if any type of variable is empty
+ * @category Validation
  * @function isEmpty
  * @param value - The variable to check
  * @returns {boolean} True if the value is empty, false otherwise
+ * @example
+ * isEmpty("");          // true
+ * isEmpty("   ");       // true
+ * isEmpty(null);        // true
+ * isEmpty([]);          // true
+ * isEmpty({});          // true
+ * isEmpty("hello");     // false
+ * isEmpty([1, 2]);      // false
  */
 declare function isEmpty(value: unknown): boolean;
 /**
  * Check if the variable is of the chosen type
+ * @category Validation
  * @function isType
  * @param value - The variable to check
  * @param type - The type you want
  * @returns {boolean} True if the value is of the chosen type, false otherwise
+ * @example
+ * isType("hello", "string");    // true
+ * isType(42, "number");         // true
+ * isType([], "object");         // true
+ * isType("42", "number");       // false
  */
 declare function isType(value: unknown, type: string): boolean;
 /**
  * Check if an email is valid
+ * @category Validation
  * @function isEmail
  * @param email - The email to check
  * @returns {boolean} True if the email is valid, false otherwise
+ * @example
+ * isEmail("alice@example.com");      // true
+ * isEmail("bob.smith@company.co.uk"); // true
+ * isEmail("invalid@.com");           // false
+ * isEmail("no-at-sign.com");         // false
  */
 declare function isEmail(email: string): boolean;
 /**
  * Check if a URL is valid
+ * @category Validation
  * @function isURL
  * @param url - The URL to check
  * @returns {boolean} True if the URL is valid, false otherwise
+ * @example
+ * isURL("https://www.example.com");     // true
+ * isURL("http://example.com/path");     // true
+ * isURL("www.example.com");             // false (missing protocol)
+ * isURL("not a url");                   // false
  */
 declare function isURL(url: string): boolean;
 /**
@@ -91,49 +164,82 @@ declare function isURL(url: string): boolean;
  */
 /**
  * Create a deep clone of any object or array
+ * @category Object Manipulation
  * @function deepClone
  * @param obj - The object or array to clone
  * @returns A deep clone of the object
+ * @example
+ * const user = { name: "Alice", skills: ["JS", "TS"] };
+ * const clone = deepClone(user);
+ * clone.name = "Bob";
+ * clone.skills[0] = "Python";
+ * console.log(user.name);    // "Alice" (unchanged)
+ * console.log(user.skills[0]); // "JS" (unchanged)
  */
 declare function deepClone<T>(obj: T): T;
 /**
  * Remove duplicate values from an array
+ * @category Object Manipulation
  * @function noTwins
  * @param arr - The array to remove duplicates from
  * @returns {unknown[]} A new array with unique values only
+ * @example
+ * noTwins([1, 2, 2, 3, 3, 3]);        // [1, 2, 3]
+ * noTwins(["a", "b", "a", "c"]);      // ["a", "b", "c"]
+ * noTwins([1, "1", 1, "1"]);          // [1, "1"]
  */
 declare function noTwins(arr: unknown[]): unknown[];
 /**
  *
- * Transforamtion utilites
+ * Transformation utilites
  *
  */
 /**
  * Transform a string to camelCase format
+ * @category Transformation
  * @function camelify
  * @param str - The string to transform
  * @returns {string} The string in camelCase format
+ * @example
+ * camelify("hello world");       // "helloWorld"
+ * camelify("C'est un test");     // "cestUnTest"
+ * camelify("foo bar baz");       // "fooBarBaz"
  */
 declare function camelify(str: string): string;
 /**
  * Transform a string to kebab-case format
+ * @category Transformation
  * @function kebabify
  * @param str - The string to transform
  * @returns {string} The string in kebab-case format
+ * @example
+ * kebabify("hello world");       // "hello-world"
+ * kebabify("C'est un test");     // "ceststun-test"
+ * kebabify("foo bar baz");       // "foo-bar-baz"
  */
 declare function kebabify(str: string): string;
 /**
  * Transform a string to snake_case format
+ * @category Transformation
  * @function snakify
  * @param str - The string to transform
  * @returns {string} The string in snake_case format
+ * @example
+ * snakify("hello world");        // "hello_world"
+ * snakify("C'est un test");      // "ceststun_test"
+ * snakify("foo bar baz");        // "foo_bar_baz"
  */
 declare function snakify(str: string): string;
 /**
  * Capitalize the first character of a string
+ * @category Transformation
  * @function capitalize
  * @param str - The string to capitalize
  * @returns {string} The string with the first character in uppercase
+ * @example
+ * capitalize("hello");        // "Hello"
+ * capitalize("hello world");  // "Hello world"
+ * capitalize("");             // ""
  */
 declare function capitalize(str: string): string;
 export { getDate, prettyError, prettyWarn, prettySuccess, prettyInfo, prettyDebug, logSeparator, logHeader, isEmpty, isType, isEmail, isURL, deepClone, noTwins, camelify, kebabify, snakify, capitalize };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,iBAAS,OAAO,CAAC,IAAI,GAAE,OAAe,GAAG,MAAM,CAE9C;AAQD;;;;;GAKG;AACH,iBAAS,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAG1D;AAED;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;GAKG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGtD;AAED;;;GAGG;AACH,iBAAS,YAAY,IAAI,IAAI,CAE5B;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAItC;AAED;;;;GAIG;AAEH;;;;;GAKG;AACH,iBAAS,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAMxC;AAED;;;;;;GAMG;AACH,iBAAS,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;;GAKG;AACH,iBAAS,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGvC;AAED;;;;;GAKG;AACH,iBAAS,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAOnC;AAED;;;;GAIG;AAEH;;;;;GAKG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAU/B;AAED;;;;;GAKG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAE1C;AAED;;;;GAIG;AAEH;;;;;GAKG;AACH,iBAAS,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAarC;AAED;;;;;GAKG;AACH,iBAAS,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASrC;AAED;;;;;GAKG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASpC;AAED;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGvC;AAKD,OAAO,EACH,OAAO,EACP,WAAW,EACX,UAAU,EACV,aAAa,EACb,UAAU,EACV,WAAW,EACX,YAAY,EACZ,SAAS,EACT,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,SAAS,EACT,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,UAAU,EACb,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,iBAAS,OAAO,CAAC,IAAI,GAAE,OAAe,GAAG,MAAM,CAE9C;AAQD;;;;;;;;;;;;GAYG;AACH,iBAAS,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAG1D;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGpD;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,IAAI,CAGtD;AAED;;;;;;;GAOG;AACH,iBAAS,YAAY,IAAI,IAAI,CAE5B;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAItC;AAED;;;;GAIG;AAEH;;;;;;;;;;;;;;GAcG;AACH,iBAAS,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAMxC;AAED;;;;;;;;;;;;GAYG;AACH,iBAAS,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGvC;AAED;;;;;;;;;;;GAWG;AACH,iBAAS,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAOnC;AAED;;;;GAIG;AAEH;;;;;;;;;;;;;GAaG;AACH,iBAAS,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAU/B;AAED;;;;;;;;;;GAUG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAE1C;AAED;;;;GAIG;AAEH;;;;;;;;;;GAUG;AACH,iBAAS,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAarC;AAED;;;;;;;;;;GAUG;AACH,iBAAS,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASrC;AAED;;;;;;;;;;GAUG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASpC;AAED;;;;;;;;;;GAUG;AACH,iBAAS,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGvC;AAKD,OAAO,EACH,OAAO,EACP,WAAW,EACX,UAAU,EACV,aAAa,EACb,UAAU,EACV,WAAW,EACX,YAAY,EACZ,SAAS,EACT,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,SAAS,EACT,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,UAAU,EACb,CAAC"}

package/dist/index.js

@@ -41,9 +41,16 @@ function getDate(time = false) {
  */
 /**
  * Show a pretty error log message with optional date information
+ * @category Logging
  * @function prettyError
  * @param err - Error message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyError("Database connection failed");
+ * // Output: ✕ - Database connection failed (in red)
+ *
+ * prettyError("Critical error", true);
+ * // Output: ✕ [30/03/2026 10:30:45] - Critical error (in red with timestamp)
  */
 function prettyError(err, time = false) {
     const date = getDate(time);
@@ -51,9 +58,16 @@ function prettyError(err, time = false) {
 }
 /**
  * Show a pretty warn log message with optional date information
+ * @category Logging
  * @function prettyWarn
  * @param warn - Warning message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyWarn("Deprecated function used");
+ * // Output: ⚠ - Deprecated function used (in orange)
+ *
+ * prettyWarn("Low memory", true);
+ * // Output: ⚠ [30/03/2026 10:30:45] - Low memory (in orange with timestamp)
  */
 function prettyWarn(warn, time = false) {
     const date = getDate(time);
@@ -61,9 +75,16 @@ function prettyWarn(warn, time = false) {
 }
 /**
  * Show a pretty success log message with optional date information
+ * @category Logging
  * @function prettySuccess
  * @param success - Success message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettySuccess("User created successfully");
+ * // Output: ✔ - User created successfully (in green)
+ *
+ * prettySuccess("Data saved", true);
+ * // Output: ✔ [30/03/2026 10:30:45] - Data saved (in green with timestamp)
  */
 function prettySuccess(success, time = false) {
     const date = getDate(time);
@@ -71,9 +92,16 @@ function prettySuccess(success, time = false) {
 }
 /**
  * Show a pretty information log message with optional date information
+ * @category Logging
  * @function prettyInfo
  * @param info - Information message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyInfo("Server is running on port 3000");
+ * // Output: ℹ - Server is running on port 3000 (in blue)
+ *
+ * prettyInfo("Cache cleared", true);
+ * // Output: ℹ [30/03/2026 10:30:45] - Cache cleared (in blue with timestamp)
  */
 function prettyInfo(info, time = false) {
     const date = getDate(time);
@@ -81,9 +109,16 @@ function prettyInfo(info, time = false) {
 }
 /**
  * Show a pretty debug log message with optional date information
+ * @category Logging
  * @function prettyDebug
  * @param debug - Debug message to display
  * @param time - Include or not a timestamp
+ * @example
+ * prettyDebug("Variable x = 42");
+ * // Output: ⚙ - Variable x = 42 (in white)
+ *
+ * prettyDebug("Function call trace", true);
+ * // Output: ⚙ [30/03/2026 10:30:45] - Function call trace (in white with timestamp)
  */
 function prettyDebug(debug, time = false) {
     const date = getDate(time);
@@ -91,15 +126,26 @@ function prettyDebug(debug, time = false) {
 }
 /**
  * Show a separator line in console
+ * @category Logging
  * @function logSeparator
+ * @example
+ * logSeparator();
+ * // Output: ══════════════════════════════════════════════════
  */
 function logSeparator() {
     console.log(`\x1b[1m${'═'.repeat(50)}\x1b[0m`);
 }
 /**
  * Display a header with a title in the center
+ * @category Logging
  * @function logHeader
  * @param title - The title of the header
+ * @example
+ * logHeader("Welcome");
+ * // Output:
+ * // ╔═════════╗
+ * // ║ Welcome ║
+ * // ╚═════════╝
  */
 function logHeader(title) {
     console.log(`\x1b[1m╔${'═'.repeat(title.length + 2)}╗\x1b[0m`);
@@ -113,9 +159,18 @@ function logHeader(title) {
  */
 /**
  * Check if any type of variable is empty
+ * @category Validation
  * @function isEmpty
  * @param value - The variable to check
  * @returns {boolean} True if the value is empty, false otherwise
+ * @example
+ * isEmpty("");          // true
+ * isEmpty("   ");       // true
+ * isEmpty(null);        // true
+ * isEmpty([]);          // true
+ * isEmpty({});          // true
+ * isEmpty("hello");     // false
+ * isEmpty([1, 2]);      // false
  */
 function isEmpty(value) {
     if (value === null || value === undefined)
@@ -130,19 +185,31 @@ function isEmpty(value) {
 }
 /**
  * Check if the variable is of the chosen type
+ * @category Validation
  * @function isType
  * @param value - The variable to check
  * @param type - The type you want
  * @returns {boolean} True if the value is of the chosen type, false otherwise
+ * @example
+ * isType("hello", "string");    // true
+ * isType(42, "number");         // true
+ * isType([], "object");         // true
+ * isType("42", "number");       // false
  */
 function isType(value, type) {
     return typeof value === type;
 }
 /**
  * Check if an email is valid
+ * @category Validation
  * @function isEmail
  * @param email - The email to check
  * @returns {boolean} True if the email is valid, false otherwise
+ * @example
+ * isEmail("alice@example.com");      // true
+ * isEmail("bob.smith@company.co.uk"); // true
+ * isEmail("invalid@.com");           // false
+ * isEmail("no-at-sign.com");         // false
  */
 function isEmail(email) {
     const regex = /^[a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
@@ -150,9 +217,15 @@ function isEmail(email) {
 }
 /**
  * Check if a URL is valid
+ * @category Validation
  * @function isURL
  * @param url - The URL to check
  * @returns {boolean} True if the URL is valid, false otherwise
+ * @example
+ * isURL("https://www.example.com");     // true
+ * isURL("http://example.com/path");     // true
+ * isURL("www.example.com");             // false (missing protocol)
+ * isURL("not a url");                   // false
  */
 function isURL(url) {
     try {
@@ -170,9 +243,17 @@ function isURL(url) {
  */
 /**
  * Create a deep clone of any object or array
+ * @category Object Manipulation
  * @function deepClone
  * @param obj - The object or array to clone
  * @returns A deep clone of the object
+ * @example
+ * const user = { name: "Alice", skills: ["JS", "TS"] };
+ * const clone = deepClone(user);
+ * clone.name = "Bob";
+ * clone.skills[0] = "Python";
+ * console.log(user.name);    // "Alice" (unchanged)
+ * console.log(user.skills[0]); // "JS" (unchanged)
  */
 function deepClone(obj) {
     if (obj === null || typeof obj !== "object")
@@ -188,23 +269,33 @@ function deepClone(obj) {
 }
 /**
  * Remove duplicate values from an array
+ * @category Object Manipulation
  * @function noTwins
  * @param arr - The array to remove duplicates from
  * @returns {unknown[]} A new array with unique values only
+ * @example
+ * noTwins([1, 2, 2, 3, 3, 3]);        // [1, 2, 3]
+ * noTwins(["a", "b", "a", "c"]);      // ["a", "b", "c"]
+ * noTwins([1, "1", 1, "1"]);          // [1, "1"]
  */
 function noTwins(arr) {
     return Array.from(new Set(arr));
 }
 /**
  *
- * Transforamtion utilites
+ * Transformation utilites
  *
  */
 /**
  * Transform a string to camelCase format
+ * @category Transformation
  * @function camelify
  * @param str - The string to transform
  * @returns {string} The string in camelCase format
+ * @example
+ * camelify("hello world");       // "helloWorld"
+ * camelify("C'est un test");     // "cestUnTest"
+ * camelify("foo bar baz");       // "fooBarBaz"
  */
 function camelify(str) {
     let camelCased = "";
@@ -222,9 +313,14 @@ function camelify(str) {
 }
 /**
  * Transform a string to kebab-case format
+ * @category Transformation
  * @function kebabify
  * @param str - The string to transform
  * @returns {string} The string in kebab-case format
+ * @example
+ * kebabify("hello world");       // "hello-world"
+ * kebabify("C'est un test");     // "ceststun-test"
+ * kebabify("foo bar baz");       // "foo-bar-baz"
  */
 function kebabify(str) {
     let kebabised = "";
@@ -238,9 +334,14 @@ function kebabify(str) {
 }
 /**
  * Transform a string to snake_case format
+ * @category Transformation
  * @function snakify
  * @param str - The string to transform
  * @returns {string} The string in snake_case format
+ * @example
+ * snakify("hello world");        // "hello_world"
+ * snakify("C'est un test");      // "ceststun_test"
+ * snakify("foo bar baz");        // "foo_bar_baz"
  */
 function snakify(str) {
     let snaked = "";
@@ -254,9 +355,14 @@ function snakify(str) {
 }
 /**
  * Capitalize the first character of a string
+ * @category Transformation
  * @function capitalize
  * @param str - The string to capitalize
  * @returns {string} The string with the first character in uppercase
+ * @example
+ * capitalize("hello");        // "Hello"
+ * capitalize("hello world");  // "Hello world"
+ * capitalize("");             // ""
  */
 function capitalize(str) {
     if (isEmpty(str))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clear-af.js",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Make your code readable af with zero bullsh*t utilities.",
   "keywords": [
     "javascript",

package/README_FR.md

@@ -1,123 +0,0 @@
-# clear-af.js
-
-Un package JavaScript rempli d'utilitaires pour rendre votre code **lisible af**. Parce que la clarté, c'est la clé de la survie en programmation.
-
-📖 **Languages** : [🇬🇧 English](README.md) | [🇫🇷 Français](#)
-
----
-
-## 📦 Installation
-```bash
-npm install clear-af
-```
-
----
-
-## 🚀 Utilisation rapide
-```javascript
-const clear = require('clear-af');
-
-clear.prettyError("Une erreur !");
-clear.camelify("hello world"); // "helloWorld"
-clear.isEmpty(data);
-```
-
----
-
-## ✨ Fonctionnalités
-
-### 🔍 Logging amélioré
-Messages colorés et formatés pour un meilleur debugging.
-```javascript
-clear.prettyError(error);
-clear.prettySuccess(message);
-clear.prettyWarn(warning);
-```
-
-### ✅ Validation facile
-Vérifiez vos données rapidement.
-```javascript
-clear.isEmpty(value);
-clear.isEmail("test@example.com");
-clear.isURL("https://example.com");
-```
-
-### 🔄 Manipulation d'objets
-Clonez profondément et manipulez vos données.
-```javascript
-clear.deepClone(obj);
-clear.noTwins([1, 2, 2, 3]); // [1, 2, 3]
-```
-
-### 📝 Transformation de strings
-Convertissez vos strings en différents formats.
-```javascript
-clear.camelify("hello world");   // "helloWorld"
-clear.kebabify("hello world");   // "hello-world"
-clear.snakify("hello world");    // "hello_world"
-clear.capitalize("hello");       // "Hello"
-```
-
----
-
-## 📚 API Complète
-
-### Logging
-- `prettyError(message, showTime?)`
-- `prettyWarn(message, showTime?)`
-- `prettySuccess(message, showTime?)`
-- `prettyInfo(message, showTime?)`
-- `prettyDebug(message, showTime?)`
-- `logSeparator()`
-- `logHeader(title)`
-
-### Validation
-- `isEmpty(value)`
-- `isType(value, type)`
-- `isEmail(email)`
-- `isURL(url)`
-
-### Objets & Arrays
-- `deepClone(obj)`
-- `noTwins(array)`
-
-### Transformation de strings
-- `camelify(string)`
-- `kebabify(string)`
-- `snakify(string)`
-- `capitalize(string)`
-
----
-
-## 🤔 FAQ
-
-**Q: Pourquoi "-af" dans le nom ?**  
-R: Parce que ton code doit être lisible *af*, mec.
-
-**Q: Compatible avec TypeScript ?**  
-R: Oui ! Les types TypeScript sont inclus.
-
-**Q: Ça ralentit mon app ?**  
-R: Non, zéro overhead. Ce ne sont que des helpers.
-
----
-
-## 📝 Licence
-
-MIT - Libre de l'utiliser comme bon vous semble.
-
----
-
-## 🤝 Contribution
-
-Les contributions sont bienvenues !
-```bash
-git clone https://github.com/FroostDev/clear-af.js
-cd clear-af.js
-npm install
-npm run build
-```
-
----
-
-**clear-af.js** - *Parce que la clarté, c'est la santé mentale du dev.* 🖤

package/docs/.nojekyll

@@ -1 +0,0 @@
-TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/hierarchy.js

@@ -1 +0,0 @@
-window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzytWsqqurQUAmx4Kpg=="