tiny-essentials 1.27.1 → 1.28.1

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

@@ -67,7 +67,7 @@ export type ScrollListenersFunc = (payload: any) => void;
  * This class is **not framework-dependent** and works with vanilla DOM elements and the window object.
  * @template {Element|Window} HTMLTarget
  */
-declare class TinySmartScroller<HTMLTarget extends Element | Window> {
+declare class TinySmartScroller<HTMLTarget extends Element | Window> extends EventEmitter<any> {
     static Utils: {
         TinyHtml: typeof TinyHtml;
         getElsRelativeCenterOffset(rect1: ObjRect, rect2: ObjRect): {
@@ -87,7 +87,7 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
             isNeg: NegCollDirs;
         };
         areElsCollTop: (rect1: ObjRect, rect2: ObjRect) => boolean;
-        areElsCollBottom: (rect1: ObjRect, rect2: ObjRect) => boolean;
+        areElsCollBottom: (rect1: ObjRect /** @type {null|EventListenerOrEventListenerObject} */, rect2: ObjRect) => boolean;
         areElsCollLeft: (rect1: ObjRect, rect2: ObjRect) => boolean;
         areElsCollRight: (rect1: ObjRect, rect2: ObjRect) => boolean;
         areElsCollPerfTop: (rect1: ObjRect, rect2: ObjRect) => boolean;
@@ -95,15 +95,10 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
         areElsCollPerfLeft: (rect1: ObjRect, rect2: ObjRect) => boolean;
         areElsCollPerfRight: (rect1: ObjRect, rect2: ObjRect) => boolean;
         areElsColliding: (rect1: ObjRect, rect2: ObjRect) => boolean;
-        areElsPerfColliding: (rect1: ObjRect, rect2: ObjRect
-        /**
-         * Removes all event listeners of a specific type from the element.
-         *
-         * @param {string|string[]} event - The event type to remove (e.g. 'onScrollBoundary').
-         */
-        ) => boolean;
+        areElsPerfColliding: (rect1: ObjRect, rect2: ObjRect) => boolean;
         getElsColliding: (rect1: ObjRect, rect2: ObjRect) => string | null;
-        getElsPerfColliding: (rect1: ObjRect, rect2: ObjRect) => "top" | "bottom" | "left" | "right" | null;
+        getElsPerfColliding: (rect1: ObjRect, // === debounceTime ===
+        rect2: ObjRect) => "top" | "bottom" | "left" | "right" | null;
         getElsCollOverlap: (rect1: ObjRect, rect2: ObjRect) => {
             overlapLeft: number;
             overlapRight: number;
@@ -119,11 +114,7 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
             dirX: Dirs;
             dirY: Dirs;
         };
-        getRectCenter: (/////////////////////////////
-        /** @type {WeakMap<Element, NodeSizes>} */
-        rect: ObjRect
-        /** @type {WeakMap<Element, NodeSizes>} */
-        ) => {
+        getRectCenter: (rect: ObjRect) => {
             x: number;
             y: number;
         };
@@ -152,134 +143,6 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
         querySelector?: string | null | undefined;
         attributeFilter?: string[] | Set<string> | null | undefined;
     });
-    /**
-     * Enables or disables throwing an error when the maximum number of listeners is exceeded.
-     *
-     * @param {boolean} shouldThrow - If true, an error will be thrown when the max is exceeded.
-     */
-    setThrowOnMaxListeners(shouldThrow: boolean): void;
-    /**
-     * Checks whether an error will be thrown when the max listener limit is exceeded.
-     *
-     * @returns {boolean} True if an error will be thrown, false if only a warning is shown.
-     */
-    getThrowOnMaxListeners(): boolean;
-    /**
-     * Adds a listener to the beginning of the listeners array for the specified event.
-     *
-     * @param {string|string[]} event - Event name.
-     * @param {ScrollListenersFunc} handler - The callback function.
-     */
-    prependListener(event: string | string[], handler: ScrollListenersFunc): void;
-    /**
-     * Adds a one-time listener to the beginning of the listeners array for the specified event.
-     *
-     * @param {string|string[]} event - Event name.
-     * @param {ScrollListenersFunc} handler - The callback function.
-     * @returns {ScrollListenersFunc[]} - The wrapped handler used internally.
-     */
-    prependListenerOnce(event: string | string[], handler: ScrollListenersFunc): ScrollListenersFunc[];
-    /**
-     * Adds a event listener.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {ScrollListenersFunc} handler - Callback function to be called when event fires.
-     */
-    appendListener(event: string | string[], handler: ScrollListenersFunc): void;
-    /**
-     * Registers an event listener that runs only once, then is removed.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {ScrollListenersFunc} handler - The callback function to run on event.
-     * @returns {ScrollListenersFunc[]} - The wrapped version of the handler.
-     */
-    appendListenerOnce(event: string | string[], handler: ScrollListenersFunc): ScrollListenersFunc[];
-    /**
-     * Adds a event listener.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {ScrollListenersFunc} handler - Callback function to be called when event fires.
-     */
-    on(event: string | string[], handler: ScrollListenersFunc): void;
-    /**
-     * Registers an event listener that runs only once, then is removed.
-     *
-     * @param {string|string[]} event - Event name, such as 'onScrollBoundary' or 'onAutoScroll'.
-     * @param {ScrollListenersFunc} handler - The callback function to run on event.
-     * @returns {ScrollListenersFunc[]} - The wrapped version of the handler.
-     */
-    once(event: string | string[], handler: ScrollListenersFunc): ScrollListenersFunc[];
-    /**
-     * Removes a previously registered event listener.
-     *
-     * @param {string|string[]} event - The name of the event to remove the handler from.
-     * @param {ScrollListenersFunc} handler - The specific callback function to remove.
-     */
-    off(event: string | string[], handler: ScrollListenersFunc): void;
-    /**
-     * Removes all event listeners of a specific type from the element.
-     *
-     * @param {string|string[]} event - The event type to remove (e.g. 'onScrollBoundary').
-     */
-    offAll(event: string | string[]): void;
-    /**
-     * Removes all event listeners of all types from the element.
-     */
-    offAllTypes(): void;
-    /**
-     * Returns the number of listeners for a given event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {number} Number of listeners for the event.
-     */
-    listenerCount(event: string): number;
-    /**
-     * Returns a copy of the array of listeners for the specified event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {ScrollListenersFunc[]} Array of listener functions.
-     */
-    listeners(event: string): ScrollListenersFunc[];
-    /**
-     * Returns a copy of the array of listeners for the specified event.
-     *
-     * @param {string} event - The name of the event.
-     * @returns {ScrollListenersFunc[]} Array of listener functions.
-     */
-    onceListeners(event: string): ScrollListenersFunc[];
-    /**
-     * Returns a copy of the internal listeners array for the specified event,
-     * including wrapper functions like those used by `.once()`.
-     * @param {string | symbol} event - The event name.
-     * @returns {ScrollListenersFunc[]} An array of raw listener functions.
-     */
-    allListeners(event: string | symbol): ScrollListenersFunc[];
-    /**
-     * Returns an array of event names for which there are registered listeners.
-     *
-     * @returns {string[]} Array of registered event names.
-     */
-    eventNames(): string[];
-    /**
-     * Emits an event, triggering all registered handlers for that event.
-     *
-     * @param {string} event - The event name to emit.
-     * @param {...any} payload - Optional data to pass to each handler.
-     * @returns {boolean[]} True if any listeners were called, false otherwise.
-     */
-    emit(event: string, ...payload: any[]): boolean[];
-    /**
-     * Sets the maximum number of listeners per event before a warning is shown.
-     *
-     * @param {number} n - The maximum number of listeners.
-     */
-    setMaxListeners(n: number): void;
-    /**
-     * Gets the maximum number of listeners allowed per event.
-     *
-     * @returns {number} The maximum number of listeners.
-     */
-    getMaxListeners(): number;
     /**
      * Returns a size difference callback that only reacts when height changes, filtered by tag name.
      *
@@ -375,37 +238,40 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
      * Checks which elements inside the target are currently visible and updates internal maps.
      *
      * @returns {Map<Element, { oldIsVisible: boolean; isVisible: boolean }>} Visibility comparison results.
+     * @private
      */
-    _scrollDataUpdater(): Map<Element, {
-        oldIsVisible: boolean;
-        isVisible: boolean;
-    }>;
+    private _scrollDataUpdater;
     /**
      * Handles scroll events, calculates position-related statuses, and emits appropriate events.
+     * @private
      */
-    _onScroll(): void;
+    private _onScroll;
     /**
      * Attempts to correct the scroll position when layout shifts happen, preserving the user position if needed.
      *
      * @param {Element[]} [targets=[]] - List of elements involved in the size change.
+     * @private
      */
-    _fixScroll(targets?: Element[]): void;
+    private _fixScroll;
     /**
      * Sets up a MutationObserver to watch for DOM changes and react accordingly to maintain scroll consistency.
+     * @private
      */
-    _observeMutations(): void;
+    private _observeMutations;
     /**
      * Adds a ResizeObserver to monitor elements' size changes and trigger layout adjustments.
      *
      * @param {NodeListOf<Element>|Element[]|HTMLCollection} elements - Elements to observe.
+     * @private
      */
-    _observeResizes(elements: NodeListOf<Element> | Element[] | HTMLCollection): void;
+    private _observeResizes;
     /**
      * Listens for media/content load events (e.g., images, iframes, videos) to trigger scroll updates.
      *
      * @param {NodeListOf<Element>|Element} elements - Target element(s) to listen on.
+     * @private
      */
-    _listenLoadEvents(elements: NodeListOf<Element> | Element): void;
+    private _listenLoadEvents;
     get target(): HTMLTarget;
     /**
      * Returns the internal scroll container element being monitored.
@@ -594,6 +460,7 @@ declare class TinySmartScroller<HTMLTarget extends Element | Window> {
     destroy(): void;
     #private;
 }
+import { EventEmitter } from 'events';
 import TinyHtml from './TinyHtml.mjs';
 import * as TinyCollision from '../basics/collision.mjs';
 //# sourceMappingURL=TinySmartScroller.d.mts.map