@webalternatif/js-core 1.6.6 → 1.6.7

package/dist/cjs/utils.js

@@ -247,6 +247,13 @@ var debounce = exports.debounce = function debounce(func, wait) {
 };
 var getScrollbarWidth = exports.getScrollbarWidth = function () {
   var scrollbarWidth = null;
+
+  /**
+   * Returns the browser scrollbar width in pixels.
+   * The value is computed once and then cached.
+   *
+   * @returns {number} - The scrollbar width in pixels.
+   */
   return function () {
     if (scrollbarWidth === null) {
       var outer = document.createElement('div');

package/dist/esm/utils.js

@@ -243,6 +243,13 @@ export var debounce = function debounce(func, wait) {
 };
 export var getScrollbarWidth = function () {
   var scrollbarWidth = null;
+
+  /**
+   * Returns the browser scrollbar width in pixels.
+   * The value is computed once and then cached.
+   *
+   * @returns {number} - The scrollbar width in pixels.
+   */
   return function () {
     if (scrollbarWidth === null) {
       var outer = document.createElement('div');

package/package.json

@@ -12,7 +12,7 @@
     "name": "Ludovic Tarit",
     "email": "ludovic.tarit@webalternatif.com"
   },
-  "version": "1.6.6",
+  "version": "1.6.7",
   "type": "module",
   "types": "types/index.d.ts",
   "main": "dist/cjs/index.js",

package/src/utils.js

@@ -244,6 +244,12 @@ export const debounce = function (func, wait, immediate = false, context = null)
 export const getScrollbarWidth = (() => {
     let scrollbarWidth = null
 
+    /**
+     * Returns the browser scrollbar width in pixels.
+     * The value is computed once and then cached.
+     *
+     * @returns {number} - The scrollbar width in pixels.
+     */
     return function () {
         if (scrollbarWidth === null) {
             const outer = document.createElement('div')

package/types/index.d.ts

@@ -19,7 +19,7 @@ declare const webf: {
     strParseFloat: (val: any) => number;
     throttle: (func: Function, wait: number, leading?: boolean, trailing?: boolean, context?: any) => Function;
     debounce: (func: Function, wait: number, immediate?: boolean, context?: any) => Function;
-    getScrollbarWidth: () => any;
+    getScrollbarWidth: () => number;
     round: (val: number, precision?: number) => number;
     floorTo: (val: number, precision: number) => number;
     plancher: (val: number, precision: number) => number;

package/types/utils.d.ts

@@ -5,4 +5,4 @@ export function flatten(o: Object | any[]): any[];
 export function strParseFloat(val: any): number;
 export function throttle(func: Function, wait: number, leading?: boolean, trailing?: boolean, context?: any): Function;
 export function debounce(func: Function, wait: number, immediate?: boolean, context?: any): Function;
-export function getScrollbarWidth(): any;
+export function getScrollbarWidth(): number;