types definition enhancements

Author: memob0x

src/get-layout-dimensions.js

@@ -24,7 +24,7 @@ const getLayoutOuterDimensions = (element, scroller) => {
  * @example
  * getLayoutDimensions(document.querySelector('div')) // --> { outerHeight: 123, ... }
  * @param {HTMLElement} element - The given element whose dimensions need to be retrieved.
- * @param {Client|HTMLElement} scroller - The given scrollable used to retrieve some
+ * @param {GlobalContext|HTMLElement} scroller - The given scrollable used to retrieve some
  * dimensions when the given element is global (page).
  * @returns {LayoutDimensions} The given element dimensions as an object ({ top, left }).
  */

src/get-scroll-position.js

@@ -5,7 +5,7 @@ import './typedef.js';
  * @public
  * @example
  * getScrollPosition(document.queryselector('div')); // --> { top: 123, left: 345 }
- * @param {Client|HTMLElement} element - The given element whose scroll
+ * @param {GlobalContext|HTMLElement} element - The given element whose scroll
  * position needs to be retrieved.
  * @returns {ScrollPosition} The given element scroll position
  * as an object ({ top, left }).

src/scroll-padlock.js

@@ -70,10 +70,10 @@ class ScrollPadlock {
    * @public
    * @throws {TypeError} Throws when the given constructor arguments are invalid.
    * @throws {Error} Throws when an instance is already attached to the given dom element.
-   * @param {HTMLElement | ScrollPadlockOptions} [scrollingElementArgument] - The given scrollable
+   * @param {HTMLElement|ConstructorOptions} [scrollingElementArgument] - The given scrollable
    * element whose scroll needs to be controlled or an options object.
    * @param {string} [cssClassNameArgument] - The locked-state css class or an options object.
-   * @param {Client} [clientArgument] - The client environment object (window).
+   * @param {GlobalContext} [clientArgument] - The client environment object (window).
    */
   constructor(scrollingElementArgument, cssClassNameArgument, clientArgument = globalThis) {
     // The Padlock first argument type
@@ -303,7 +303,7 @@ class ScrollPadlock {
   /**
    * A reference to the client "window" object.
    * @private
-   * @type {Client}
+   * @type {GlobalContext}
    * @memberof ScrollPadlock
    */
   #window = null;
@@ -382,15 +382,15 @@ class ScrollPadlock {
 
   /**
    * The current scroll position.
-   * @type {Types.ScrollPosition}
+   * @type {ScrollPosition}
    * @private
    * @memberof ScrollPadlock
    */
   #scrollCurrent = null;
 
   /**
    * The scroll position saving, the scroll position stored for later use.
-   * @type {Types.ScrollPosition}
+   * @type {ScrollPosition}
    * @private
    * @memberof ScrollPadlock
    */
@@ -475,7 +475,7 @@ class ScrollPadlock {
    * const padlock = new ScrollPadlock();
    *
    * padlock.scroll // --> { top: 123, left: 345 }
-   * @returns {Types.ScrollPosition} The current scroll position object or the
+   * @returns {ScrollPosition} The current scroll position object or the
    * scroll position previously saved if on a locked state.
    */
   get scroll() {
@@ -492,7 +492,7 @@ class ScrollPadlock {
    * const padlock = new ScrollPadlock();
    *
    * padlock.scroll = { top: 123, left: 345 }
-   * @param {Types.ScrollPosition} position - The scroll position to be set
+   * @param {ScrollPosition} position - The scroll position to be set
    * or saved if on a locked state.
    */
   set scroll(position) {
@@ -517,7 +517,7 @@ class ScrollPadlock {
    * const padlock = new ScrollPadlock();
    *
    * padlock.layout // --> { outerHeight: 123, outerWidth: 345, innerWidth: 123, ... }
-   * @returns {Types.Layout} The layout object.
+   * @returns {LayoutDimensions} The layout object.
    */
   get layout() {
     return this.#layout;
@@ -578,7 +578,7 @@ class ScrollPadlock {
    * Window resize event handler, bound with the wrapper function.
    * @private
    * @memberof ScrollPadlock
-   * @type {Handler}
+   * @type {EventHandler}
    */
   #handleResize = this.#resizeHandler.bind(this);
 
@@ -600,7 +600,7 @@ class ScrollPadlock {
    * Element scroll event handler, bound with the wrapper function.
    * @private
    * @memberof ScrollPadlock
-   * @type {Handler}
+   * @type {EventHandler}
    */
   #handleScroll = this.#scrollHandler.bind(this);
 
@@ -620,7 +620,7 @@ class ScrollPadlock {
    * Scrolls the given element to a given scroll position.
    * @private
    * @memberof ScrollPadlock
-   * @param {Types.ScrollPosition} position - The scroll position to be set.
+   * @param {ScrollPosition} position - The scroll position to be set.
    * @returns {void} Nothing.
    */
   #scrollTo = (position) => this.#scrollEventElement?.scrollTo(
@@ -679,7 +679,7 @@ class ScrollPadlock {
    * Updates the layout object.
    * @private
    * @memberof ScrollPadlock
-   * @returns {Types.ScrollPosition} The layout object.
+   * @returns {LayoutDimensions} The layout object.
    */
   #updateLayout() {
     // If the elements involved are set (if not the instance has been probably destroyed)
@@ -696,7 +696,7 @@ class ScrollPadlock {
    * Refresh the scroll position at a (temporarly) unlocked state.
    * @private
    * @memberof ScrollPadlock
-   * @returns {Types.ScrollPosition} The current scroll position object.
+   * @returns {ScrollPosition} The current scroll position object.
    */
   #updateScrollCurrent() {
     // If the involved element is set (if not the instance has been probably destroyed)

src/typedef.js

@@ -17,27 +17,28 @@
  */
 
 /**
- * @typedef Client
+ * @typedef GlobalContext
  * @type {Window & typeof globalThis}
  */
 
 /**
- * @callback Handler
+ * @callback EventHandler
  * @returns {void}
  */
 
 /**
- * @callback HandlerWrapper
- * @param {Handler} predicate
- * @returns {Handler}
+ * @callback EventHandlerWrapper
+ * @param {EventHandler} predicate - The original handler function.
+ * @returns {EventHandler}
  */
 
 /**
- * @typedef ScrollPadlockOptions
- * @property {HTMLElement} scrollingElement Asd.
- * @property {Client | HTMLElement} scrollEventElement Asd.
- * @property {string} cssClassName Asd.
- * @property {HandlerWrapper} resizeHandlerWrapper Asd.
- * @property {HandlerWrapper} scrollHandlerWrapper Asd.
- * @property {Client} client Asd.
+ * @typedef ConstructorOptions
+ * @property {HTMLElement} scrollingElement The html element that can perform the scrolling action.
+ * @property {GlobalContext|HTMLElement} scrollEventElement The element that can
+ * perform and listen to scroll event.
+ * @property {string} cssClassName The lock state CSS class name.
+ * @property {EventHandlerWrapper} resizeHandlerWrapper The "resize" event handler function wrapper.
+ * @property {EventHandlerWrapper} scrollHandlerWrapper The "scroll" event handler function wrapper.
+ * @property {GlobalContext} client A reference to the client "window" object.
  */