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

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;

package/utils/string/withoutTrailingCharacters.d.ts

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

package/utils/string/withoutTrailingCharactersRecursive.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 withoutTrailingCharactersRecursive(string: string, characters: string): string;

package/utils/string/withoutTrailingSlash.d.ts

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

package/utils/throttle.cjs

@@ -25,7 +25,7 @@ module.exports = __toCommonJS(throttle_exports);
 function throttle(fn, delay = 16) {
   let lastCall = 0;
   return function throttled(...args) {
-    const now = new Date().getTime();
+    const now = Date.now();
     if (now - lastCall < delay) {
       return false;
     }

package/utils/throttle.d.ts

@@ -2,7 +2,7 @@
  * Simple throttling helper that limits a function to only run once every {delay}ms.
  *
  * @param {Function} fn The function to throttle
- * @param {Number=} [delay=16] The delay in ms
- * @return {Function} The throttled function.
+ * @param {number} [delay] The delay in ms
+ * @returns {Function} The throttled function.
  */
-export default function throttle(fn: Function, delay?: number | undefined): Function;
+export default function throttle(fn: Function, delay?: number): Function;

package/utils/throttle.js

@@ -1,7 +1,7 @@
 function throttle(fn, delay = 16) {
   let lastCall = 0;
   return function throttled(...args) {
-    const now = new Date().getTime();
+    const now = Date.now();
     if (now - lastCall < delay) {
       return false;
     }