@studiometa/js-toolkit 2.0.0-rc.2 → 2.0.0

package/utils/collide/collideRectRect.d.ts

@@ -1,9 +1,9 @@
 /**
  * @typedef {Object} Rect
- * @property {Number} x Rectangle's x position
- * @property {Number} y Rectangle's y position
- * @property {Number} width Rectangle's width
- * @property {Number} height Rectangle's height
+ * @property {number} x Rectangle's x position
+ * @property {number} y Rectangle's y position
+ * @property {number} width Rectangle's width
+ * @property {number} height Rectangle's height
  */
 /**
  * Test if a rectangle collides with another rectangle.
@@ -11,7 +11,7 @@
  *
  * @param {Rect} rect1 Rectangle 1
  * @param {Rect} rect2 Rectangle 2
- * @return {boolean} Are the sides of one rectangle touching the other ?
+ * @returns {boolean} Are the sides of one rectangle touching the other ?
  */
 export default function collideRectRect(rect1: Rect, rect2: Rect): boolean;
 export type Rect = {

package/utils/css/classes.cjs

@@ -24,7 +24,7 @@ __export(classes_exports, {
   toggle: () => toggle
 });
 module.exports = __toCommonJS(classes_exports);
-function setClasses(element, classNames, method = "add", forceToggle = void 0) {
+function setClasses(element, classNames, method, forceToggle) {
   if (!element || !classNames) {
     return;
   }
@@ -36,12 +36,12 @@ function setClasses(element, classNames, method = "add", forceToggle = void 0) {
   }
 }
 function add(element, classNames) {
-  setClasses(element, classNames);
+  setClasses(element, classNames, "add");
 }
 function remove(element, classNames) {
   setClasses(element, classNames, "remove");
 }
-function toggle(element, classNames, force = void 0) {
+function toggle(element, classNames, force) {
   setClasses(element, classNames, "toggle", force);
 }
 if (module.exports.default) module.exports = module.exports.default;

package/utils/css/classes.d.ts

@@ -1,25 +1,25 @@
 /**
  * Add class names to an element.
  *
- * @param  {HTMLElement}     element    The element to update.
- * @param  {string|string[]} classNames A string of class names.
- * @return {void}
+ * @param   {HTMLElement}     element    The element to update.
+ * @param   {string|string[]} classNames A string of class names.
+ * @returns {void}
  */
 export function add(element: HTMLElement, classNames: string | string[]): void;
 /**
  * Remove class names from an element.
  *
- * @param  {HTMLElement}     element    The element to update.
- * @param  {string|string[]} classNames A string of class names.
- * @return {void}
+ * @param   {HTMLElement}     element    The element to update.
+ * @param   {string|string[]} classNames A string of class names.
+ * @returns {void}
  */
 export function remove(element: HTMLElement, classNames: string | string[]): void;
 /**
  * Toggle class names from an element.
  *
- * @param  {HTMLElement}     element    The element to update.
- * @param  {string|string[]} classNames A string of class names.
- * @param  {boolean}         [force]    Force toggle?
- * @return {void}
+ * @param   {HTMLElement}     element    The element to update.
+ * @param   {string|string[]} classNames A string of class names.
+ * @param   {boolean}         [force]    Force toggle?
+ * @returns {void}
  */
 export function toggle(element: HTMLElement, classNames: string | string[], force?: boolean): void;

package/utils/css/classes.js

@@ -1,4 +1,4 @@
-function setClasses(element, classNames, method = "add", forceToggle = void 0) {
+function setClasses(element, classNames, method, forceToggle) {
   if (!element || !classNames) {
     return;
   }
@@ -10,12 +10,12 @@ function setClasses(element, classNames, method = "add", forceToggle = void 0) {
   }
 }
 function add(element, classNames) {
-  setClasses(element, classNames);
+  setClasses(element, classNames, "add");
 }
 function remove(element, classNames) {
   setClasses(element, classNames, "remove");
 }
-function toggle(element, classNames, force = void 0) {
+function toggle(element, classNames, force) {
   setClasses(element, classNames, "toggle", force);
 }
 export {

package/utils/css/matrix.d.ts

@@ -1,15 +1,14 @@
 /**
  * Format a CSS transform matrix with the given values.
  *
- * @param  {Object}  transform
- * @param  {Number=} [transform.scaleX=1]     The scale on the x axis.
- * @param  {Number=} [transform.scaleY=1]     The scale on the y axis.
- * @param  {Number=} [transform.skewX=0]      The skew on the x axis.
- * @param  {Number=} [transform.skewY=0]      The skew on the y axis.
- * @param  {Number=} [transform.translateX=0] The translate on the x axis.
- * @param  {Number=} [transform.translateY=0] The translate on the y axis.
- * @return {String}                           A formatted CSS matrix transform.
- *
+ * @param   {Object} transform
+ * @param   {number} [transform.scaleX=1]     The scale on the x axis.
+ * @param   {number} [transform.scaleY=1]     The scale on the y axis.
+ * @param   {number} [transform.skewX=0]      The skew on the x axis.
+ * @param   {number} [transform.skewY=0]      The skew on the y axis.
+ * @param   {number} [transform.translateX=0] The translate on the x axis.
+ * @param   {number} [transform.translateY=0] The translate on the y axis.
+ * @returns {string}                           A formatted CSS matrix transform.
  * @example
  * ```js
  * matrix({ scaleX: 0.5, scaleY: 0.5 });
@@ -17,10 +16,10 @@
  * ```
  */
 export default function matrix(transform: {
-    scaleX?: number | undefined;
-    scaleY?: number | undefined;
-    skewX?: number | undefined;
-    skewY?: number | undefined;
-    translateX?: number | undefined;
-    translateY?: number | undefined;
+    scaleX?: number;
+    scaleY?: number;
+    skewX?: number;
+    skewY?: number;
+    translateX?: number;
+    translateY?: number;
 }): string;

package/utils/css/styles.d.ts

@@ -3,7 +3,7 @@
  *
  * @param {HTMLElement}                  element The element to update.
  * @param {Partial<CSSStyleDeclaration>} styles  A string of class names.
- * @return {void}
+ * @returns {void}
  */
 export function add(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): void;
 /**
@@ -11,6 +11,6 @@ export function add(element: HTMLElement, styles: Partial<CSSStyleDeclaration>):
  *
  * @param  {HTMLElement}                  element The element to update.
  * @param  {Partial<CSSStyleDeclaration>} styles  A string of class names.
- * @return {void}
+ * @returns {void}
  */
 export function remove(element: HTMLElement, styles: Partial<CSSStyleDeclaration>): void;

package/utils/css/transition.d.ts

@@ -14,8 +14,8 @@ export function setClassesOrStyles(element: HTMLElement, classesOrStyles: Classe
  *
  * @param  {HTMLElement}             element The target element.
  * @param  {string|TransitionStyles} name    The name of the transition or an object with the hooks classesOrStyles.
- * @param  {String}                  endMode Whether to remove or keep the `to` classes/styles
- * @return {Promise<void>}                   A promise resolving at the end of the transition.
+ * @param  {string}                  endMode Whether to remove or keep the `to` classes/styles
+ * @returns {Promise<void>}                   A promise resolving at the end of the transition.
  */
 export default function transition(element: HTMLElement, name: string | TransitionStyles, endMode?: string): Promise<void>;
 export type ClassesOrStyles = string | string[] | Partial<CSSStyleDeclaration>;

package/utils/debounce.d.ts

@@ -3,8 +3,8 @@
  * will not be triggered. The function will be called after it stops
  * being called for N milliseconds.
  *
- * @param {(...args:any[]) => void} fn The function to call.
- * @param {Number=} [delay=300] The delay in ms to wait before calling the function.
- * @return {(...args:any[]) => void} The debounced function.
+ * @param   {(...args:any[]) => void} fn The function to call.
+ * @param   {number} [delay=300] The delay in ms to wait before calling the function.
+ * @returns {(...args:any[]) => void} The debounced function.
  */
-export default function debounce(fn: (...args: any[]) => void, delay?: number | undefined): (...args: any[]) => void;
+export default function debounce(fn: (...args: any[]) => void, delay?: number): (...args: any[]) => void;

package/utils/focusTrap.cjs

@@ -63,7 +63,7 @@ function trap(element, event) {
     event.preventDefault();
   }
   if (event.shiftKey && focusedItemIndex === 0) {
-    focusableChildren[focusableChildren.length - 1].focus();
+    focusableChildren.at(-1).focus();
     event.preventDefault();
   } else if (!event.shiftKey && focusedItemIndex === focusableChildren.length - 1) {
     focusableChildren[0].focus();

package/utils/focusTrap.d.ts

@@ -14,6 +14,7 @@ export function trap(element: HTMLElement, event: KeyboardEvent): void;
 export function untrap(): void;
 /**
  * Use a trap/untrap tabs logic.
+ * @returns {{ trap: trap, untrap: untrap, saveActiveElement: saveActiveElement }}
  */
 export default function useFocusTrap(): {
     trap: typeof trap;

package/utils/focusTrap.js

@@ -33,7 +33,7 @@ function trap(element, event) {
     event.preventDefault();
   }
   if (event.shiftKey && focusedItemIndex === 0) {
-    focusableChildren[focusableChildren.length - 1].focus();
+    focusableChildren.at(-1).focus();
     event.preventDefault();
   } else if (!event.shiftKey && focusedItemIndex === focusableChildren.length - 1) {
     focusableChildren[0].focus();

package/utils/history.d.ts

@@ -1,31 +1,33 @@
 /**
  * Transform an object to an URLSearchParams instance.
  *
- * @param  {Object}          obj           The object to convert.
- * @param  {string}          defaultSearch A string of defaults search params.
- * @return {URLSearchParams}
+ * @param   {Object}          obj           The object to convert.
+ * @param   {string}          defaultSearch A string of defaults search params.
+ * @returns {URLSearchParams}
  */
 export function objectToURLSearchParams(obj: any, defaultSearch?: string): URLSearchParams;
 /**
  * Push a new state.
  *
- * @param {HistoryOptions} options The new state.
- * @param {Object}         [data]  The data for the new state.
- * @param {string}         [title] The title for the new state.
+ * @param   {HistoryOptions} options The new state.
+ * @param   {Object}         [data]  The data for the new state.
+ * @param   {string}         [title] The title for the new state.
+ * @returns {void}
  */
 export function push(options: HistoryOptions, data?: any, title?: string): void;
 /**
  * Replace a new state.
  *
- * @param {HistoryOptions} options The new state.
- * @param {Object}         [data]  The data for the new state.
- * @param {string}         [title] The title for the new state.
+ * @param   {HistoryOptions} options The new state.
+ * @param   {Object}         [data]  The data for the new state.
+ * @param   {string}         [title] The title for the new state.
+ * @returns {void}
  */
 export function replace(options: HistoryOptions, data?: any, title?: string): void;
 export type HistoryOptions = {
-    path?: string | undefined;
+    path?: string;
     search?: URLSearchParams | {
         [key: string]: unknown;
     };
-    hash?: string | undefined;
+    hash?: string;
 };

package/utils/math/clamp.d.ts

@@ -3,6 +3,6 @@
  * @param {number} value
  * @param {number} min
  * @param {number} max
- * @return {number}
+ * @returns {number}
  */
 export default function clamp(value: number, min: number, max: number): number;

package/utils/math/clamp01.d.ts

@@ -1,6 +1,6 @@
 /**
  * Clamp a value in the 0–1 range.
  * @param {number} value
- * @return {number}
+ * @returns {number}
  */
 export default function clamp01(value: number): number;

package/utils/math/damp.d.ts

@@ -1,10 +1,10 @@
 /**
  * Get the next damped value for a given factor.
  *
- * @param  {number} targetValue The final value.
- * @param  {number} currentValue The current value.
- * @param  {number=} [factor=0.5] The factor used to reach the target value.
- * @param  {number=} [precision=0.01] The precision used to calculate the latest value.
- * @return {number} The next value.
+ * @param   {number} targetValue The final value.
+ * @param   {number} currentValue The current value.
+ * @param   {number} [factor=0.5] The factor used to reach the target value.
+ * @param   {number} [precision=0.01] The precision used to calculate the latest value.
+ * @returns {number} The next value.
  */
-export default function damp(targetValue: number, currentValue: number, factor?: number | undefined, precision?: number | undefined): number;
+export default function damp(targetValue: number, currentValue: number, factor?: number, precision?: number): number;

package/utils/math/ease.d.ts

@@ -12,7 +12,7 @@ export function createEaseOut(easeIn: EasingFunction): EasingFunction;
  * Create an in-out easing function.
  *
  * @param  {EasingFunction} easeIn The ease in function.
- * @return {EasingFunction}        The in-out function.
+ * @returns {EasingFunction}        The in-out function.
  */
 export function createEaseInOut(easeIn: EasingFunction): EasingFunction;
 /**
@@ -23,42 +23,42 @@ export function easeInQuad(progress: number): number;
  * Ease in cubic.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInCubic(progress: number): number;
 /**
  * Ease in quart.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInQuart(progress: number): number;
 /**
  * Ease in quint.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInQuint(progress: number): number;
 /**
  * Ease in sine.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInSine(progress: number): number;
 /**
  * Ease in circ.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInCirc(progress: number): number;
 /**
  * Ease in exponential.
  *
  * @param  {number} progress Progress value betwen 0 and 1.
- * @return {number}          Eased value between 0 and 1.
+ * @returns {number}          Eased value between 0 and 1.
  */
 export function easeInExpo(progress: number): number;
 export function easeOutQuad(progress: number): number;

package/utils/math/inertiaFinalValue.d.ts

@@ -1,9 +1,9 @@
 /**
  * Get the final damped value for a given factor.
  *
- * @param  {Number} initialValue The final value.
- * @param  {Number} initialDelta The current value.
- * @param  {Number=} [dampFactor=0.85] The speed to reach the target value.
- * @return {Number} The next value.
+ * @param   {number} initialValue The final value.
+ * @param   {number} initialDelta The current value.
+ * @param   {number} [dampFactor=0.85] The speed to reach the target value.
+ * @returns {number} The next value.
  */
-export default function inertiaFinalValue(initialValue: number, initialDelta: number, dampFactor?: number | undefined): number;
+export default function inertiaFinalValue(initialValue: number, initialDelta: number, dampFactor?: number): number;

package/utils/math/lerp.d.ts

@@ -1,9 +1,9 @@
 /**
  * Interpolate the ratio between a given interval.
  *
- * @param  {Number} min   The interval minimum value.
- * @param  {Number} max   The inverval maximum value.
- * @param  {Number} ratio The ratio to get.
- * @return {Number}       The value between min and max corresponding to ratio.
+ * @param  {number} min   The interval minimum value.
+ * @param  {number} max   The inverval maximum value.
+ * @param  {number} ratio The ratio to get.
+ * @returns {number}       The value between min and max corresponding to ratio.
  */
 export default function lerp(min: number, max: number, ratio: number): number;

package/utils/math/map.d.ts

@@ -1,11 +1,11 @@
 /**
  * Maps the value from one range of [inputMin..inputMax] to another range of [outputMin..outputMax].
  *
- * @param  {Number} value     The value to map.
- * @param  {Number} inputMin  The input's minimum value.
- * @param  {Number} inputMax  The input's maximum value.
- * @param  {Number} outputMin The output's minimum value.
- * @param  {Number} outputMax The output's maximum value.
- * @return {Number}           The input value mapped to the output range.
+ * @param  {number} value     The value to map.
+ * @param  {number} inputMin  The input's minimum value.
+ * @param  {number} inputMax  The input's maximum value.
+ * @param  {number} outputMin The output's minimum value.
+ * @param  {number} outputMax The output's maximum value.
+ * @returns {number}           The input value mapped to the output range.
  */
 export default function map(value: number, inputMin: number, inputMax: number, outputMin: number, outputMax: number): number;

package/utils/math/round.d.ts

@@ -1,8 +1,8 @@
 /**
  * Round a value with a given number of decimals.
  *
- * @param  {Number} value The number to round.
- * @param  {Number=} [decimals=0] The number of decimals to keep.
- * @return {Number} A rounded number to the given decimals length.
+ * @param   {number} value The number to round.
+ * @param   {number} [decimals=0] The number of decimals to keep.
+ * @returns {number} A rounded number to the given decimals length.
  */
-export default function round(value: number, decimals?: number | undefined): number;
+export default function round(value: number, decimals?: number): number;

package/utils/memoize.d.ts

@@ -15,7 +15,7 @@
  * @template {(...args:any) => any} T
  * @param  {T} fn
  * @param  {MemorizeOptions} options
- * @return {(...args:Parameters<T>) => ReturnType<T>}
+ * @returns {(...args:Parameters<T>) => ReturnType<T>}
  */
 export default function memoize<T extends (...args: any) => any>(fn: T, { maxAge, cacheKey, cache }?: MemorizeOptions): (...args: Parameters<T>) => ReturnType<T>;
 export type MemorizeCache = {

package/utils/nextFrame.d.ts

@@ -1,22 +1,21 @@
 /**
  * RequestAnimation frame polyfill.
  * @see  https://github.com/vuejs/vue/blob/ec78fc8b6d03e59da669be1adf4b4b5abf670a34/dist/vue.runtime.esm.js#L7355
- * @return {(handler: Function) => number}
+ * @returns {(handler: Function) => number}
  */
 export function getRaf(): (handler: Function) => number;
 /**
  * Get a function to cancel the method returned by `getRaf()`.
  *
- * @return {(id:number) => void}
+ * @returns {(id:number) => void}
  */
 export function getCancelRaf(): (id: number) => void;
 /**
  * Wait for the next frame to execute a function.
  *
  * @template {() => any} T
- * @param    {T=} [fn] The callback function to execute.
+ * @param    {T} [fn] The callback function to execute.
  * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>} A Promise resolving when the next frame is reached.
- *
  * @example
  * ```js
  * nextFrame(() => console.log('hello world'));

package/utils/nextMicrotask.d.ts

@@ -2,7 +2,7 @@
  * Wait for the next microtask.
  *
  * @template {() => any} T
- * @param    {T=} [fn]
+ * @param    {T} [fn]
  * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>}
  */
 export default function nextMicrotask<T extends () => any>(fn?: T): Promise<T extends Function ? ReturnType<T> : undefined>;

package/utils/nextTick.d.ts

@@ -2,7 +2,7 @@
  * Wait for the next tick.
  *
  * @template {() => any} T
- * @param    {T=} [fn]
+ * @param    {T} [fn]
  * @returns  {Promise<T extends Function ? ReturnType<T> : undefined>}
  */
 export default function nextTick<T extends () => any>(fn?: T): Promise<T extends Function ? ReturnType<T> : undefined>;

package/utils/object/autoBind.d.ts

@@ -3,9 +3,9 @@
  *
  * @param  {Object}               instance          The instance.
  * @param  {Object}               options           Define specific methods to include or exlude.
- * @param  {Array<String|RegExp>} [options.include] Methods to include.
- * @param  {Array<String|RegExp>} [options.exclude] Methods to exclude.
- * @return {Object}                                 The instance.
+ * @param  {Array<string | RegExp>} [options.include] Methods to include.
+ * @param  {Array<string | RegExp>} [options.exclude] Methods to exclude.
+ * @returns {Object}                                 The instance.
  */
 export default function autoBind(instance: any, options: {
     include?: Array<string | RegExp>;

package/utils/object/getAllProperties.d.ts

@@ -3,9 +3,9 @@
  *
  * @param {Object} object
  *   The object to get the propeties from.
- * @param {Array=} [props=[]]
+ * @param {Array} [props=[]]
  *   The already existing properties.
  * @param {(name:string, proto:any) => boolean} testFn
- * @return {Array<[String, Object]>} An array of properties and the prototype they belong to.
+ * @returns {Array<[string, Object]>} An array of properties and the prototype they belong to.
  */
-export default function getAllProperties(object: any, props?: any[] | undefined, testFn?: (name: string, proto: any) => boolean): Array<[string, any]>;
+export default function getAllProperties(object: any, props?: any[], testFn?: (name: string, proto: any) => boolean): Array<[string, any]>;

package/utils/object/isObject.d.ts

@@ -2,6 +2,6 @@
  * Test if the given value is an object.
  *
  * @param {*} value The value to test.
- * @return {Boolean} Whether or not the value is an object.
+ * @returns {boolean} Whether or not the value is an object.
  */
 export default function isObject(value: any): boolean;

package/utils/scrollTo.cjs

@@ -39,7 +39,7 @@ function scrollTo(selectorElement, { offset = 0, dampFactor = 0.2 } = {}) {
   const sizes = targetElement.getBoundingClientRect();
   const scrollMargin = getComputedStyle(targetElement).scrollMarginTop || "0";
   const max = document.documentElement.scrollHeight - window.innerHeight;
-  let scrollTarget = sizes.top + window.pageYOffset - parseInt(scrollMargin, 10) - offset;
+  let scrollTarget = sizes.top + window.pageYOffset - Number.parseInt(scrollMargin, 10) - offset;
   if (scrollTarget > max) {
     scrollTarget = max;
   }

package/utils/scrollTo.d.ts

@@ -3,7 +3,7 @@
  *
  * @param {HTMLElement|string} selectorElement The target element.
  * @param {{ offset?: number, dampFactor?: number }} [options] Options for the scroll.
- * @return {Promise<number>} A promising resolving with the target scroll position.
+ * @returns {Promise<number>} A promising resolving with the target scroll position.
  */
 export default function scrollTo(selectorElement: HTMLElement | string, { offset, dampFactor }?: {
     offset?: number;

package/utils/scrollTo.js

@@ -12,7 +12,7 @@ function scrollTo(selectorElement, { offset = 0, dampFactor = 0.2 } = {}) {
   const sizes = targetElement.getBoundingClientRect();
   const scrollMargin = getComputedStyle(targetElement).scrollMarginTop || "0";
   const max = document.documentElement.scrollHeight - window.innerHeight;
-  let scrollTarget = sizes.top + window.pageYOffset - parseInt(scrollMargin, 10) - offset;
+  let scrollTarget = sizes.top + window.pageYOffset - Number.parseInt(scrollMargin, 10) - offset;
   if (scrollTarget > max) {
     scrollTarget = max;
   }

package/utils/string/withLeadingCharacters.d.ts

@@ -1,7 +1,8 @@
 /**
  * Add the given characters to the start of the given string.
  *
- * @param {string} string     The string to modify.
- * @param {string} characters The characters to add to the start.
+ * @param   {string} string     The string to modify.
+ * @param   {string} characters The characters to add to the start.
+ * @returns {string}
  */
 export default function withLeadingCharacters(string: string, characters: string): string;

package/utils/string/withLeadingSlash.d.ts

@@ -2,6 +2,6 @@
  * Add a leading slash to a string.
  *
  * @param {string} string The string to modify.
- * @return {string} The string with a leading slash.
+ * @returns {string} The string with a leading slash.
  */
 export default function withLeadingSlash(string: string): string;

package/utils/string/withTrailingCharacters.d.ts

@@ -1,7 +1,8 @@
 /**
  * Add the given characters to the end of the given string.
  *
- * @param {string} string     The string to modify.
- * @param {string} characters The characters to add to the end.
+ * @param   {string} string     The string to modify.
+ * @param   {string} characters The characters to add to the end.
+ * @returns {string}
  */
 export default function withTrailingCharacters(string: string, characters: string): string;

package/utils/string/withTrailingSlash.d.ts

@@ -2,6 +2,6 @@
  * Add a trailing slash to a string.
  *
  * @param {string} string The string to modify.
- * @return {string} The string with a trailing slash.
+ * @returns {string} The string with a trailing slash.
  */
 export default function withTrailingSlash(string: string): string;

package/utils/string/withoutLeadingCharacters.d.ts

@@ -1,7 +1,8 @@
 /**
  * Remove the given characters from the start of the given string.
  *
- * @param {string} string     The string to modify.
- * @param {string} characters The characters to remove from the start.
+ * @param   {string} string     The string to modify.
+ * @param   {string} characters The characters to remove from the start.
+ * @returns {string}
  */
 export default function withoutLeadingCharacters(string: string, characters: string): string;

package/utils/string/withoutLeadingCharactersRecursive.d.ts

@@ -1,7 +1,8 @@
 /**
  * Remove the given characters to the start of the given string recursively.
  *
- * @param {string} string     The string to modify.
- * @param {string} characters The characters to add to the start.
+ * @param   {string} string     The string to modify.
+ * @param   {string} characters The characters to add to the start.
+ * @returns {string}
  */
 export default function withoutLeadingCharactersRecursive(string: string, characters: string): string;

package/utils/string/withoutLeadingSlash.d.ts

@@ -2,6 +2,6 @@
  * Remove the leading slash from a string.
  *
  * @param {string} string The string to modify.
- * @return {string} The string without leading slash.
+ * @returns {string} The string without leading slash.
  */
 export default function withoutLeadingSlash(string: string): string;