@medyll/idae-be 0.84.0 → 0.86.0

package/dist/modules/text.js

@@ -85,27 +85,104 @@ export class TextHandler {
         });
         return this.beElement;
     }
+    /**
+     * Updates the text content of the element(s).
+     * @param content - The new text content to set.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Original</div>
+     * const beInstance = be('#test');
+     * beInstance.updateText('Updated'); // Updates the text content to "Updated"
+     */
     update(content, callback) {
         return this.handle({ update: content, callback });
     }
+    /**
+     * Appends text content to the element(s).
+     * @param content - The text content to append.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Original</div>
+     * const beInstance = be('#test');
+     * beInstance.appendText(' Appended'); // Appends " Appended" to the text content
+     */
     append(content, callback) {
         return this.handle({ append: content, callback });
     }
+    /**
+     * Prepends text content to the element(s).
+     * @param content - The text content to prepend.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Original</div>
+     * const beInstance = be('#test');
+     * beInstance.prependText('Prepended '); // Prepends "Prepended " to the text content
+     */
     prepend(content, callback) {
         return this.handle({ prepend: content, callback });
     }
+    /**
+     * Replaces the text content of the element(s).
+     * @param content - The new text content to replace with.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Original</div>
+     * const beInstance = be('#test');
+     * beInstance.replaceText('Replaced'); // Replaces the text content with "Replaced"
+     */
     replace(content, callback) {
         return this.handle({ replace: content, callback });
     }
+    /**
+     * Removes the element(s) from the DOM.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">To be removed</div>
+     * const beInstance = be('#test');
+     * beInstance.removeText(); // Removes the element
+     */
     remove(callback) {
         return this.handle({ remove: undefined, callback });
     }
+    /**
+     * Clears the text content of the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Content</div>
+     * const beInstance = be('#test');
+     * beInstance.clearText(); // Clears the text content
+     */
     clear(callback) {
         return this.handle({ clear: undefined, callback });
     }
+    /**
+     * Normalizes the text content of the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Text <span>Fragment</span> Text</div>
+     * const beInstance = be('#test');
+     * beInstance.normalizeText(); // Normalizes the text content
+     */
     normalize(callback) {
         return this.handle({ normalize: undefined, callback });
     }
+    /**
+     * Wraps the element(s) with a new element.
+     * @param content - The wrapper element as a string or HTMLElement.
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test">Content</div>
+     * const beInstance = be('#test');
+     * beInstance.wrapText('<div class="wrapper"></div>'); // Wraps the element with a <div>
+     */
     wrap(content, callback) {
         return this.handle({ wrap: content, callback });
     }

package/dist/modules/timers.d.ts

@@ -17,9 +17,49 @@ export declare class TimersHandler implements CommonHandler<TimersHandler> {
     methods: string[] | keyof TimersHandler;
     valueOf(): unknown;
     handle(actions: TimerHandlerHandle): Be;
+    /**
+     * Sets a timeout for the element(s).
+     * @param value - The timeout duration in milliseconds.
+     * @param callback - The callback function to execute after the timeout.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.timeout(1000, () => console.log('Timeout executed')); // Sets a 1-second timeout
+     */
     timeout(value: TimerHandlerHandle['timeout'], callback?: HandlerCallBackFn): Be;
+    /**
+     * Sets an interval for the element(s).
+     * @param value - The interval duration in milliseconds.
+     * @param callback - The callback function to execute at each interval.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.interval(500, () => console.log('Interval executed')); // Sets a 500ms interval
+     */
     interval(value: TimerHandlerHandle['interval'], callback?: HandlerCallBackFn): Be;
+    /**
+     * Clears the timeout for the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.timeout(1000, () => console.log('Timeout executed'));
+     * beInstance.clearTimeout(); // Clears the timeout
+     */
     clearTimeout(callback?: HandlerCallBackFn): Be;
+    /**
+     * Clears the interval for the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.interval(500, () => console.log('Interval executed'));
+     * beInstance.clearInterval(); // Clears the interval
+     */
     clearInterval(callback?: HandlerCallBackFn): Be;
 }
 export {};

package/dist/modules/timers.js

@@ -39,6 +39,16 @@ export class TimersHandler {
         });
         return this.beElement;
     }
+    /**
+     * Sets a timeout for the element(s).
+     * @param value - The timeout duration in milliseconds.
+     * @param callback - The callback function to execute after the timeout.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.timeout(1000, () => console.log('Timeout executed')); // Sets a 1-second timeout
+     */
     timeout(value, callback) {
         this.beElement.timerOut = setTimeout(() => {
             callback?.({
@@ -61,6 +71,16 @@ export class TimersHandler {
         }); */
         return this.beElement;
     }
+    /**
+     * Sets an interval for the element(s).
+     * @param value - The interval duration in milliseconds.
+     * @param callback - The callback function to execute at each interval.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.interval(500, () => console.log('Interval executed')); // Sets a 500ms interval
+     */
     interval(value, callback) {
         this.beElement.timerInterval = setInterval(() => {
             callback?.({
@@ -83,6 +103,16 @@ export class TimersHandler {
         }); */
         return this.beElement;
     }
+    /**
+     * Clears the timeout for the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.timeout(1000, () => console.log('Timeout executed'));
+     * beInstance.clearTimeout(); // Clears the timeout
+     */
     clearTimeout(callback) {
         if (this.beElement.timerOut)
             clearTimeout(this.beElement.timerOut);
@@ -102,6 +132,16 @@ export class TimersHandler {
         });
         return this.beElement;
     }
+    /**
+     * Clears the interval for the element(s).
+     * @param callback - Optional callback function.
+     * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="test"></div>
+     * const beInstance = be('#test');
+     * beInstance.interval(500, () => console.log('Interval executed'));
+     * beInstance.clearInterval(); // Clears the interval
+     */
     clearInterval(callback) {
         if (this.beElement.timerInterval)
             clearInterval(this.beElement.timerInterval);

package/dist/modules/walk.d.ts

@@ -114,6 +114,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="child"></div><div id="parent"><div id="child"></div></div>
+     * const beInstance = be('#child');
+     * beInstance.up(); // Traverses to the parent element
      */
     up(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**
@@ -121,6 +125,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling1');
+     * beInstance.next(); // Traverses to the next sibling
      */
     next(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**
@@ -128,6 +136,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling2');
+     * beInstance.previous(); // Traverses to the previous sibling
      */
     previous(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**
@@ -142,6 +154,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling1');
+     * beInstance.siblings(); // Finds all sibling elements
      */
     siblings(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**
@@ -149,6 +165,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="parent"><div id="child"></div></div>
+     * const beInstance = be('#parent');
+     * beInstance.children(); // Finds all child elements
      */
     children(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**
@@ -156,6 +176,10 @@ export declare class WalkHandler implements WalkHandlerInterface, CommonHandler<
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="ancestor"><div id="parent"><div id="child"></div></div></div>
+     * const beInstance = be('#child');
+     * beInstance.closest('#ancestor'); // Finds the closest ancestor matching the selector
      */
     closest(qy?: string | HandlerCallBackFn, callback?: HandlerCallBackFn): Be;
     /**

package/dist/modules/walk.js

@@ -47,6 +47,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="child"></div><div id="parent"><div id="child"></div></div>
+     * const beInstance = be('#child');
+     * beInstance.up(); // Traverses to the parent element
      */
     up(qy, callback) {
         if (typeof qy === 'function') {
@@ -60,6 +64,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling1');
+     * beInstance.next(); // Traverses to the next sibling
      */
     next(qy, callback) {
         if (typeof qy === 'function') {
@@ -73,6 +81,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling2');
+     * beInstance.previous(); // Traverses to the previous sibling
      */
     previous(qy, callback) {
         if (typeof qy === 'function') {
@@ -108,6 +120,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="sibling1"></div><div id="sibling2"></div>
+     * const beInstance = be('#sibling1');
+     * beInstance.siblings(); // Finds all sibling elements
      */
     siblings(qy, callback) {
         if (typeof qy === 'function') {
@@ -134,6 +150,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="parent"><div id="child"></div></div>
+     * const beInstance = be('#parent');
+     * beInstance.children(); // Finds all child elements
      */
     children(qy, callback) {
         if (typeof qy === 'function') {
@@ -147,6 +167,10 @@ export class WalkHandler {
      * @param qy - Optional selector or callback function.
      * @param callback - Optional callback function.
      * @returns The Be instance for method chaining.
+     * @example
+     * // HTML: <div id="ancestor"><div id="parent"><div id="child"></div></div></div>
+     * const beInstance = be('#child');
+     * beInstance.closest('#ancestor'); // Finds the closest ancestor matching the selector
      */
     closest(qy, callback) {
         if (typeof qy === 'function') {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@medyll/idae-be",
 	"scope": "@medyll",
-	"version": "0.84.0",
+	"version": "0.86.0",
 	"description": "A powerful DOM manipulation library with a callback-based approach for precise element targeting. Provides consistent chaining, comprehensive DOM traversal, event handling, style management, and more. Written in TypeScript for modern browsers.",
 	"scripts": {
 		"dev": "vite dev",