@studiometa/js-toolkit 3.1.0 → 3.2.0

package/utils/getComponentResolver.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/getComponentResolver.ts"],
-  "sourcesContent": ["import { isFunction } from './is.js';\n\n/**\n * Default component resolver\n *\n * @param {Function} fn\n * @returns {Function}\n */\nexport function getComponentResolver(fn) {\n  return (resolve, cb?: () => unknown) => {\n    fn().then((module) => {\n      const ResolvedClass = module.default ?? module;\n      resolve(ResolvedClass);\n\n      if (isFunction(cb)) {\n        cb();\n      }\n    });\n  };\n}\n"],
+  "sourcesContent": ["import { isFunction } from './is.js';\n\n/**\n * Default component resolver\n *\n * @param {Function} fn\n * @return {Function}\n */\nexport function getComponentResolver(fn) {\n  return (resolve, cb?: () => unknown) => {\n    fn().then((module) => {\n      const ResolvedClass = module.default ?? module;\n      resolve(ResolvedClass);\n\n      if (isFunction(cb)) {\n        cb();\n      }\n    });\n  };\n}\n"],
   "mappings": "AAAA,SAAS,kBAAkB;AAQpB,SAAS,qBAAqB,IAAI;AACvC,SAAO,CAAC,SAAS,OAAuB;AACtC,OAAG,EAAE,KAAK,CAAC,WAAW;AACpB,YAAM,gBAAgB,OAAO,WAAW;AACxC,cAAQ,aAAa;AAErB,UAAI,WAAW,EAAE,GAAG;AAClB,WAAG;AAAA,MACL;AAAA,IACF,CAAC;AAAA,EACH;AACF;",
   "names": []
 }

package/utils/history.d.ts

@@ -8,26 +8,29 @@ export interface HistoryOptions {
 /**
  * Transform an object to an URLSearchParams instance.
  *
- * @param   {Object}          obj           The object to convert.
- * @param   {string}          defaultSearch A string of defaults search params.
- * @returns {URLSearchParams}
- */
+ * @param  {Object}          obj           The object to convert.
+ * @param  {string}          defaultSearch A string of defaults search params.
+ * @return {URLSearchParams}
+ * @link https://js-toolkit.studiometa.dev/utils/history/objectToURLSearchParams.html
+*/
 export declare function objectToURLSearchParams(obj: unknown, 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.
- * @returns {void}
- */
+ * @param  {HistoryOptions} options The new state.
+ * @param  {Object}         [data]  The data for the new state.
+ * @param  {string}         [title] The title for the new state.
+ * @return {void}
+ * @link https://js-toolkit.studiometa.dev/utils/history/historyPush.html
+*/
 export declare function push(options: HistoryOptions, data?: unknown, 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.
- * @returns {void}
- */
+ * @param  {HistoryOptions} options The new state.
+ * @param  {Object}         [data]  The data for the new state.
+ * @param  {string}         [title] The title for the new state.
+ * @return {void}
+ * @link https://js-toolkit.studiometa.dev/utils/history/historyReplace.html
+*/
 export declare function replace(options: HistoryOptions, data?: unknown, title?: string): void;

package/utils/history.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/history.ts"],
-  "sourcesContent": ["import { isArray, isObject } from './is.js';\nimport { hasWindow } from './has.js';\nimport { startsWith } from './string/index.js';\n\nexport interface HistoryOptions {\n  path?: string;\n  search?: URLSearchParams | { [key: string]: unknown };\n  hash?: string;\n}\n\ntype SearchParamValue = string | number | boolean;\n\n/**\n * Set a param in a URLSearchParam instance.\n *\n * @param   {URLSearchParams}                    params The params to update.\n * @param   {string}                             name   The name of the param to update.\n * @param   {string|number|boolean|Array|Object} value  The value for this param.\n * @returns {URLSearchParams}                           The updated URLSearchParams instance.\n */\nfunction updateUrlSearchParam(\n  params: URLSearchParams,\n  name: string,\n  value: SearchParamValue | Array<SearchParamValue> | Record<string, SearchParamValue>,\n): URLSearchParams {\n  if (value === '' || value === null || value === undefined) {\n    if (params.has(name)) {\n      params.delete(name);\n    }\n    return params;\n  }\n\n  if (isArray(value)) {\n    for (const [index, val] of value.entries()) {\n      const arrayName = `${name}[${index}]`;\n      updateUrlSearchParam(params, arrayName, val);\n    }\n    return params;\n  }\n\n  if (isObject(value)) {\n    for (const [key, val] of Object.entries(value)) {\n      const objectName = `${name}[${key}]`;\n      updateUrlSearchParam(params, objectName, val);\n    }\n    return params;\n  }\n\n  params.set(name, value as string);\n  return params;\n}\n\n/**\n * Transform an object to an URLSearchParams instance.\n *\n * @param   {Object}          obj           The object to convert.\n * @param   {string}          defaultSearch A string of defaults search params.\n * @returns {URLSearchParams}\n */\nexport function objectToURLSearchParams(\n  obj: unknown,\n  defaultSearch = hasWindow() ? window.location.search : '',\n): URLSearchParams {\n  return Object.entries(obj).reduce(\n    (urlSearchParams: URLSearchParams, [name, value]) =>\n      updateUrlSearchParam(urlSearchParams, name, value),\n    new URLSearchParams(defaultSearch),\n  ) as URLSearchParams;\n}\n\n/**\n * Update the history with a new state.\n *\n * @param   {string}         mode\n * @param   {HistoryOptions} options\n * @param   {Object}         [data]\n * @param   {string}         [title]\n * @returns {void}\n */\nfunction updateHistory(\n  mode: 'push' | 'replace',\n  options: HistoryOptions,\n  data: unknown = {},\n  title = '',\n) {\n  if (!window.history) {\n    return;\n  }\n\n  const { path, search, hash }: HistoryOptions = {\n    path: window.location.pathname,\n    search: new URLSearchParams(window.location.search),\n    hash: window.location.hash,\n    ...options,\n  };\n\n  let url = path;\n\n  const mergedSearch = search instanceof URLSearchParams ? search : objectToURLSearchParams(search);\n\n  if (mergedSearch.toString()) {\n    url += `?${mergedSearch.toString()}`;\n  }\n\n  if (hash) {\n    if (startsWith(hash, '#')) {\n      url += hash;\n    } else {\n      url += `#${hash}`;\n    }\n  }\n\n  const method = `${mode}State`;\n  window.history[method](data, title, url);\n}\n\n/**\n * Push a new state.\n *\n * @param   {HistoryOptions} options The new state.\n * @param   {Object}         [data]  The data for the new state.\n * @param   {string}         [title] The title for the new state.\n * @returns {void}\n */\nexport function push(options: HistoryOptions, data: unknown = {}, title = '') {\n  updateHistory('push', options, data, title);\n}\n\n/**\n * Replace a new state.\n *\n * @param   {HistoryOptions} options The new state.\n * @param   {Object}         [data]  The data for the new state.\n * @param   {string}         [title] The title for the new state.\n * @returns {void}\n */\nexport function replace(options: HistoryOptions, data: unknown = {}, title = '') {\n  updateHistory('replace', options, data, title);\n}\n"],
-  "mappings": "AAAA,SAAS,SAAS,gBAAgB;AAClC,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAkB3B,SAAS,qBACP,QACA,MACA,OACiB;AACjB,MAAI,UAAU,MAAM,UAAU,QAAQ,UAAU,QAAW;AACzD,QAAI,OAAO,IAAI,IAAI,GAAG;AACpB,aAAO,OAAO,IAAI;AAAA,IACpB;AACA,WAAO;AAAA,EACT;AAEA,MAAI,QAAQ,KAAK,GAAG;AAClB,eAAW,CAAC,OAAO,GAAG,KAAK,MAAM,QAAQ,GAAG;AAC1C,YAAM,YAAY,GAAG,IAAI,IAAI,KAAK;AAClC,2BAAqB,QAAQ,WAAW,GAAG;AAAA,IAC7C;AACA,WAAO;AAAA,EACT;AAEA,MAAI,SAAS,KAAK,GAAG;AACnB,eAAW,CAAC,KAAK,GAAG,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC9C,YAAM,aAAa,GAAG,IAAI,IAAI,GAAG;AACjC,2BAAqB,QAAQ,YAAY,GAAG;AAAA,IAC9C;AACA,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,MAAM,KAAe;AAChC,SAAO;AACT;AASO,SAAS,wBACd,KACA,gBAAgB,UAAU,IAAI,OAAO,SAAS,SAAS,IACtC;AACjB,SAAO,OAAO,QAAQ,GAAG,EAAE;AAAA,IACzB,CAAC,iBAAkC,CAAC,MAAM,KAAK,MAC7C,qBAAqB,iBAAiB,MAAM,KAAK;AAAA,IACnD,IAAI,gBAAgB,aAAa;AAAA,EACnC;AACF;AAWA,SAAS,cACP,MACA,SACA,OAAgB,CAAC,GACjB,QAAQ,IACR;AACA,MAAI,CAAC,OAAO,SAAS;AACnB;AAAA,EACF;AAEA,QAAM,EAAE,MAAM,QAAQ,KAAK,IAAoB;AAAA,IAC7C,MAAM,OAAO,SAAS;AAAA,IACtB,QAAQ,IAAI,gBAAgB,OAAO,SAAS,MAAM;AAAA,IAClD,MAAM,OAAO,SAAS;AAAA,IACtB,GAAG;AAAA,EACL;AAEA,MAAI,MAAM;AAEV,QAAM,eAAe,kBAAkB,kBAAkB,SAAS,wBAAwB,MAAM;AAEhG,MAAI,aAAa,SAAS,GAAG;AAC3B,WAAO,IAAI,aAAa,SAAS,CAAC;AAAA,EACpC;AAEA,MAAI,MAAM;AACR,QAAI,WAAW,MAAM,GAAG,GAAG;AACzB,aAAO;AAAA,IACT,OAAO;AACL,aAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF;AAEA,QAAM,SAAS,GAAG,IAAI;AACtB,SAAO,QAAQ,MAAM,EAAE,MAAM,OAAO,GAAG;AACzC;AAUO,SAAS,KAAK,SAAyB,OAAgB,CAAC,GAAG,QAAQ,IAAI;AAC5E,gBAAc,QAAQ,SAAS,MAAM,KAAK;AAC5C;AAUO,SAAS,QAAQ,SAAyB,OAAgB,CAAC,GAAG,QAAQ,IAAI;AAC/E,gBAAc,WAAW,SAAS,MAAM,KAAK;AAC/C;",
+  "sourcesContent": ["import { isArray, isObject } from './is.js';\nimport { hasWindow } from './has.js';\nimport { startsWith } from './string/index.js';\n\nexport interface HistoryOptions {\n  path?: string;\n  search?: URLSearchParams | { [key: string]: unknown };\n  hash?: string;\n}\n\ntype SearchParamValue = string | number | boolean;\n\n/**\n * Set a param in a URLSearchParam instance.\n *\n * @param  {URLSearchParams}                    params The params to update.\n * @param  {string}                             name   The name of the param to update.\n * @param  {string|number|boolean|Array|Object} value  The value for this param.\n * @return {URLSearchParams}                           The updated URLSearchParams instance.\n */\nfunction updateUrlSearchParam(\n  params: URLSearchParams,\n  name: string,\n  value: SearchParamValue | Array<SearchParamValue> | Record<string, SearchParamValue>,\n): URLSearchParams {\n  if (value === '' || value === null || value === undefined) {\n    if (params.has(name)) {\n      params.delete(name);\n    }\n    return params;\n  }\n\n  if (isArray(value)) {\n    for (const [index, val] of value.entries()) {\n      const arrayName = `${name}[${index}]`;\n      updateUrlSearchParam(params, arrayName, val);\n    }\n    return params;\n  }\n\n  if (isObject(value)) {\n    for (const [key, val] of Object.entries(value)) {\n      const objectName = `${name}[${key}]`;\n      updateUrlSearchParam(params, objectName, val);\n    }\n    return params;\n  }\n\n  params.set(name, value as string);\n  return params;\n}\n\n/**\n * Transform an object to an URLSearchParams instance.\n *\n * @param  {Object}          obj           The object to convert.\n * @param  {string}          defaultSearch A string of defaults search params.\n * @return {URLSearchParams}\n * @link https://js-toolkit.studiometa.dev/utils/history/objectToURLSearchParams.html\n*/\nexport function objectToURLSearchParams(\n  obj: unknown,\n  defaultSearch = hasWindow() ? window.location.search : '',\n): URLSearchParams {\n  return Object.entries(obj).reduce(\n    (urlSearchParams: URLSearchParams, [name, value]) =>\n      updateUrlSearchParam(urlSearchParams, name, value),\n    new URLSearchParams(defaultSearch),\n  ) as URLSearchParams;\n}\n\n/**\n * Update the history with a new state.\n *\n * @param  {string}         mode\n * @param  {HistoryOptions} options\n * @param  {Object}         [data]\n * @param  {string}         [title]\n * @return {void}\n */\nfunction updateHistory(\n  mode: 'push' | 'replace',\n  options: HistoryOptions,\n  data: unknown = {},\n  title = '',\n) {\n  if (!window.history) {\n    return;\n  }\n\n  const { path, search, hash }: HistoryOptions = {\n    path: window.location.pathname,\n    search: new URLSearchParams(window.location.search),\n    hash: window.location.hash,\n    ...options,\n  };\n\n  let url = path;\n\n  const mergedSearch = search instanceof URLSearchParams ? search : objectToURLSearchParams(search);\n\n  if (mergedSearch.toString()) {\n    url += `?${mergedSearch.toString()}`;\n  }\n\n  if (hash) {\n    if (startsWith(hash, '#')) {\n      url += hash;\n    } else {\n      url += `#${hash}`;\n    }\n  }\n\n  const method = `${mode}State`;\n  window.history[method](data, title, url);\n}\n\n/**\n * Push a new state.\n *\n * @param  {HistoryOptions} options The new state.\n * @param  {Object}         [data]  The data for the new state.\n * @param  {string}         [title] The title for the new state.\n * @return {void}\n * @link https://js-toolkit.studiometa.dev/utils/history/historyPush.html\n*/\nexport function push(options: HistoryOptions, data: unknown = {}, title = '') {\n  updateHistory('push', options, data, title);\n}\n\n/**\n * Replace a new state.\n *\n * @param  {HistoryOptions} options The new state.\n * @param  {Object}         [data]  The data for the new state.\n * @param  {string}         [title] The title for the new state.\n * @return {void}\n * @link https://js-toolkit.studiometa.dev/utils/history/historyReplace.html\n*/\nexport function replace(options: HistoryOptions, data: unknown = {}, title = '') {\n  updateHistory('replace', options, data, title);\n}\n"],
+  "mappings": "AAAA,SAAS,SAAS,gBAAgB;AAClC,SAAS,iBAAiB;AAC1B,SAAS,kBAAkB;AAkB3B,SAAS,qBACP,QACA,MACA,OACiB;AACjB,MAAI,UAAU,MAAM,UAAU,QAAQ,UAAU,QAAW;AACzD,QAAI,OAAO,IAAI,IAAI,GAAG;AACpB,aAAO,OAAO,IAAI;AAAA,IACpB;AACA,WAAO;AAAA,EACT;AAEA,MAAI,QAAQ,KAAK,GAAG;AAClB,eAAW,CAAC,OAAO,GAAG,KAAK,MAAM,QAAQ,GAAG;AAC1C,YAAM,YAAY,GAAG,IAAI,IAAI,KAAK;AAClC,2BAAqB,QAAQ,WAAW,GAAG;AAAA,IAC7C;AACA,WAAO;AAAA,EACT;AAEA,MAAI,SAAS,KAAK,GAAG;AACnB,eAAW,CAAC,KAAK,GAAG,KAAK,OAAO,QAAQ,KAAK,GAAG;AAC9C,YAAM,aAAa,GAAG,IAAI,IAAI,GAAG;AACjC,2BAAqB,QAAQ,YAAY,GAAG;AAAA,IAC9C;AACA,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,MAAM,KAAe;AAChC,SAAO;AACT;AAUO,SAAS,wBACd,KACA,gBAAgB,UAAU,IAAI,OAAO,SAAS,SAAS,IACtC;AACjB,SAAO,OAAO,QAAQ,GAAG,EAAE;AAAA,IACzB,CAAC,iBAAkC,CAAC,MAAM,KAAK,MAC7C,qBAAqB,iBAAiB,MAAM,KAAK;AAAA,IACnD,IAAI,gBAAgB,aAAa;AAAA,EACnC;AACF;AAWA,SAAS,cACP,MACA,SACA,OAAgB,CAAC,GACjB,QAAQ,IACR;AACA,MAAI,CAAC,OAAO,SAAS;AACnB;AAAA,EACF;AAEA,QAAM,EAAE,MAAM,QAAQ,KAAK,IAAoB;AAAA,IAC7C,MAAM,OAAO,SAAS;AAAA,IACtB,QAAQ,IAAI,gBAAgB,OAAO,SAAS,MAAM;AAAA,IAClD,MAAM,OAAO,SAAS;AAAA,IACtB,GAAG;AAAA,EACL;AAEA,MAAI,MAAM;AAEV,QAAM,eAAe,kBAAkB,kBAAkB,SAAS,wBAAwB,MAAM;AAEhG,MAAI,aAAa,SAAS,GAAG;AAC3B,WAAO,IAAI,aAAa,SAAS,CAAC;AAAA,EACpC;AAEA,MAAI,MAAM;AACR,QAAI,WAAW,MAAM,GAAG,GAAG;AACzB,aAAO;AAAA,IACT,OAAO;AACL,aAAO,IAAI,IAAI;AAAA,IACjB;AAAA,EACF;AAEA,QAAM,SAAS,GAAG,IAAI;AACtB,SAAO,QAAQ,MAAM,EAAE,MAAM,OAAO,GAAG;AACzC;AAWO,SAAS,KAAK,SAAyB,OAAgB,CAAC,GAAG,QAAQ,IAAI;AAC5E,gBAAc,QAAQ,SAAS,MAAM,KAAK;AAC5C;AAWO,SAAS,QAAQ,SAAyB,OAAgB,CAAC,GAAG,QAAQ,IAAI;AAC/E,gBAAc,WAAW,SAAS,MAAM,KAAK;AAC/C;",
   "names": []
 }

package/utils/is.d.ts

@@ -1,38 +1,54 @@
+/**
+ * @link https://js-toolkit.studiometa.dev/utils/is/isDev.html
+ */
 export declare const isDev: boolean;
 /**
  * Test is the given value is null.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isNull.html
+*/
 export declare const isNull: (value: unknown) => value is null;
 /**
  * Test if the given value is a function.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isFunction.html
+*/
 export declare const isFunction: (value: unknown) => value is Function;
 /**
  * Test if a value is defined or not.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isDefined.html
+*/
 export declare const isDefined: (value: unknown) => boolean;
 /**
  * Test if value is a string.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isString.html
+*/
 export declare const isString: (value: unknown) => value is string;
 /**
  * Test if the given value is an object.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isObject.html
+*/
 export declare const isObject: (value: unknown) => boolean;
 /**
  * Test if a given value is a number.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isNumber.html
+*/
 export declare const isNumber: (value: unknown) => value is number;
 /**
  * Test if a given value is a boolean.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isBoolean.html
+*/
 export declare const isBoolean: (value: unknown) => value is boolean;
+/**
+ * Test if a given value is an array.
+ * @link https://js-toolkit.studiometa.dev/utils/is/isArray.html
+*/
 export declare const isArray: (arg: any) => arg is any[];
 /**
  * Test if a given value is an empty string.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isEmptyString.html
+*/
 export declare const isEmptyString: (value?: unknown) => boolean;
 /**
  * Test if the given value is empty.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/is/isEmpty.html
+*/
 export declare const isEmpty: (value?: any) => boolean;

package/utils/is.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/is.ts"],
-  "sourcesContent": ["// eslint-disable-next-line no-undef\nexport const isDev = typeof __DEV__ !== 'undefined' && __DEV__;\n\n/**\n * Test is the given value is null.\n */\nexport const isNull = (value: unknown): value is null => value === null;\n\n/**\n * Test if the given value is a function.\n */\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport const isFunction = (value: unknown): value is Function => typeof value === 'function';\n\n/**\n * Test if a value is defined or not.\n */\nexport const isDefined = (value: unknown): boolean => typeof value !== 'undefined';\n\n/**\n * Test if value is a string.\n */\nexport const isString = (value: unknown): value is string => typeof value === 'string';\n\n/**\n * Test if the given value is an object.\n */\nexport const isObject = (value: unknown): boolean =>\n  typeof value === 'object' && !!value && value.toString() === '[object Object]';\n\n/**\n * Test if a given value is a number.\n */\nexport const isNumber = (value: unknown): value is number =>\n  typeof value === 'number' && !Number.isNaN(value);\n\n/**\n * Test if a given value is a boolean.\n */\nexport const isBoolean = (value: unknown): value is boolean => typeof value === 'boolean';\n\n// eslint-disable-next-line prefer-destructuring\nexport const isArray = Array.isArray;\n\n/**\n * Test if a given value is an empty string.\n */\nexport const isEmptyString = (value?: unknown): boolean => isString(value) && value.length === 0;\n\n/**\n * Test if the given value is empty.\n */\nexport const isEmpty = (value?) => {\n  if (isNull(value) || !isDefined(value)) {\n    return true;\n  }\n\n  if (isString(value) || isArray(value)) {\n    return value.length === 0;\n  }\n\n  if (isObject(value)) {\n    return value.constructor === Object && Object.keys(value).length === 0;\n  }\n\n  return false;\n};\n"],
-  "mappings": "AACO,MAAM,QAAQ,OAAO,YAAY,eAAe;AAKhD,MAAM,SAAS,CAAC,UAAkC,UAAU;AAM5D,MAAM,aAAa,CAAC,UAAsC,OAAO,UAAU;AAK3E,MAAM,YAAY,CAAC,UAA4B,OAAO,UAAU;AAKhE,MAAM,WAAW,CAAC,UAAoC,OAAO,UAAU;AAKvE,MAAM,WAAW,CAAC,UACvB,OAAO,UAAU,YAAY,CAAC,CAAC,SAAS,MAAM,SAAS,MAAM;AAKxD,MAAM,WAAW,CAAC,UACvB,OAAO,UAAU,YAAY,CAAC,OAAO,MAAM,KAAK;AAK3C,MAAM,YAAY,CAAC,UAAqC,OAAO,UAAU;AAGzE,MAAM,UAAU,MAAM;AAKtB,MAAM,gBAAgB,CAAC,UAA6B,SAAS,KAAK,KAAK,MAAM,WAAW;AAKxF,MAAM,UAAU,CAAC,UAAW;AACjC,MAAI,OAAO,KAAK,KAAK,CAAC,UAAU,KAAK,GAAG;AACtC,WAAO;AAAA,EACT;AAEA,MAAI,SAAS,KAAK,KAAK,QAAQ,KAAK,GAAG;AACrC,WAAO,MAAM,WAAW;AAAA,EAC1B;AAEA,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,MAAM,gBAAgB,UAAU,OAAO,KAAK,KAAK,EAAE,WAAW;AAAA,EACvE;AAEA,SAAO;AACT;",
+  "sourcesContent": ["// eslint-disable-next-line no-undef\n/**\n * @link https://js-toolkit.studiometa.dev/utils/is/isDev.html\n */\nexport const isDev = typeof __DEV__ !== 'undefined' && __DEV__;\n\n/**\n * Test is the given value is null.\n * @link https://js-toolkit.studiometa.dev/utils/is/isNull.html\n*/\nexport const isNull = (value: unknown): value is null => value === null;\n\n/**\n * Test if the given value is a function.\n * @link https://js-toolkit.studiometa.dev/utils/is/isFunction.html\n*/\n// eslint-disable-next-line @typescript-eslint/ban-types\nexport const isFunction = (value: unknown): value is Function => typeof value === 'function';\n\n/**\n * Test if a value is defined or not.\n * @link https://js-toolkit.studiometa.dev/utils/is/isDefined.html\n*/\nexport const isDefined = (value: unknown): boolean => typeof value !== 'undefined';\n\n/**\n * Test if value is a string.\n * @link https://js-toolkit.studiometa.dev/utils/is/isString.html\n*/\nexport const isString = (value: unknown): value is string => typeof value === 'string';\n\n/**\n * Test if the given value is an object.\n * @link https://js-toolkit.studiometa.dev/utils/is/isObject.html\n*/\nexport const isObject = (value: unknown): boolean =>\n  typeof value === 'object' && !!value && value.toString() === '[object Object]';\n\n/**\n * Test if a given value is a number.\n * @link https://js-toolkit.studiometa.dev/utils/is/isNumber.html\n*/\nexport const isNumber = (value: unknown): value is number =>\n  typeof value === 'number' && !Number.isNaN(value);\n\n/**\n * Test if a given value is a boolean.\n * @link https://js-toolkit.studiometa.dev/utils/is/isBoolean.html\n*/\nexport const isBoolean = (value: unknown): value is boolean => typeof value === 'boolean';\n\n// eslint-disable-next-line prefer-destructuring\n/**\n * Test if a given value is an array.\n * @link https://js-toolkit.studiometa.dev/utils/is/isArray.html\n*/\nexport const isArray = Array.isArray;\n\n/**\n * Test if a given value is an empty string.\n * @link https://js-toolkit.studiometa.dev/utils/is/isEmptyString.html\n*/\nexport const isEmptyString = (value?: unknown): boolean => isString(value) && value.length === 0;\n\n/**\n * Test if the given value is empty.\n * @link https://js-toolkit.studiometa.dev/utils/is/isEmpty.html\n*/\nexport const isEmpty = (value?) => {\n  if (isNull(value) || !isDefined(value)) {\n    return true;\n  }\n\n  if (isString(value) || isArray(value)) {\n    return value.length === 0;\n  }\n\n  if (isObject(value)) {\n    return value.constructor === Object && Object.keys(value).length === 0;\n  }\n\n  return false;\n};\n"],
+  "mappings": "AAIO,MAAM,QAAQ,OAAO,YAAY,eAAe;AAMhD,MAAM,SAAS,CAAC,UAAkC,UAAU;AAO5D,MAAM,aAAa,CAAC,UAAsC,OAAO,UAAU;AAM3E,MAAM,YAAY,CAAC,UAA4B,OAAO,UAAU;AAMhE,MAAM,WAAW,CAAC,UAAoC,OAAO,UAAU;AAMvE,MAAM,WAAW,CAAC,UACvB,OAAO,UAAU,YAAY,CAAC,CAAC,SAAS,MAAM,SAAS,MAAM;AAMxD,MAAM,WAAW,CAAC,UACvB,OAAO,UAAU,YAAY,CAAC,OAAO,MAAM,KAAK;AAM3C,MAAM,YAAY,CAAC,UAAqC,OAAO,UAAU;AAOzE,MAAM,UAAU,MAAM;AAMtB,MAAM,gBAAgB,CAAC,UAA6B,SAAS,KAAK,KAAK,MAAM,WAAW;AAMxF,MAAM,UAAU,CAAC,UAAW;AACjC,MAAI,OAAO,KAAK,KAAK,CAAC,UAAU,KAAK,GAAG;AACtC,WAAO;AAAA,EACT;AAEA,MAAI,SAAS,KAAK,KAAK,QAAQ,KAAK,GAAG;AACrC,WAAO,MAAM,WAAW;AAAA,EAC1B;AAEA,MAAI,SAAS,KAAK,GAAG;AACnB,WAAO,MAAM,gBAAgB,UAAU,OAAO,KAAK,KAAK,EAAE,WAAW;AAAA,EACvE;AAEA,SAAO;AACT;",
   "names": []
 }

package/utils/keyCodes.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @link https://js-toolkit.studiometa.dev/utils/keyCodes.html
+ */
 export declare const keyCodes: {
     readonly ENTER: 13;
     readonly SPACE: 32;

package/utils/keyCodes.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/keyCodes.ts"],
-  "sourcesContent": ["export const keyCodes = {\n  ENTER: 13,\n  SPACE: 32,\n  TAB: 9,\n  ESC: 27,\n  LEFT: 37,\n  UP: 38,\n  RIGHT: 39,\n  DOWN: 40,\n} as const;\n"],
-  "mappings": "AAAO,MAAM,WAAW;AAAA,EACtB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,KAAK;AAAA,EACL,KAAK;AAAA,EACL,MAAM;AAAA,EACN,IAAI;AAAA,EACJ,OAAO;AAAA,EACP,MAAM;AACR;",
+  "sourcesContent": ["/**\n * @link https://js-toolkit.studiometa.dev/utils/keyCodes.html\n */\nexport const keyCodes = {\n  ENTER: 13,\n  SPACE: 32,\n  TAB: 9,\n  ESC: 27,\n  LEFT: 37,\n  UP: 38,\n  RIGHT: 39,\n  DOWN: 40,\n} as const;\n"],
+  "mappings": "AAGO,MAAM,WAAW;AAAA,EACtB,OAAO;AAAA,EACP,OAAO;AAAA,EACP,KAAK;AAAA,EACL,KAAK;AAAA,EACL,MAAM;AAAA,EACN,IAAI;AAAA,EACJ,OAAO;AAAA,EACP,MAAM;AACR;",
   "names": []
 }

package/utils/loadElement.d.ts

@@ -20,23 +20,28 @@ export type LoadElementsReturnType<T extends LoadableElementsNames> = Promise<{
 /**
  * Load the given source for the given type of element.
  * @todo manage memo
- */
+ * @link https://js-toolkit.studiometa.dev/utils/loadElement.html
+*/
 export declare function loadElement<T extends LoadableElementsNames>(src: string, type: T, { appendTo }?: LoadElementsOptions): LoadElementsReturnType<T>;
 /**
  * Load the given source as an `<img>` element.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/loadImage.html
+*/
 export declare function loadImage(src: string, options?: LoadElementsOptions): LoadElementsReturnType<"img">;
 /**
  * Load the given source as an `<iframe>` element.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/loadIframe.html
+*/
 export declare function loadIframe(src: string, options?: LoadElementsOptions): LoadElementsReturnType<"iframe">;
 /**
  * Load the given source as a `<link>` element.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/loadLink.html
+*/
 export declare function loadLink(src: string, options?: LoadElementsOptions): LoadElementsReturnType<"link">;
 /**
  * Load the given source as a `<script>` element. The generated element is
  * appended to `document.head` by default, as a script element needs
  * to be inserted in the DOM to load.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/loadScript.html
+*/
 export declare function loadScript(src: string, options?: LoadElementsOptions): LoadElementsReturnType<"script">;

package/utils/loadElement.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../packages/js-toolkit/utils/loadElement.ts"],
-  "sourcesContent": ["export type LoadableElements = {\n  embed: HTMLEmbedElement;\n  iframe: HTMLIFrameElement;\n  img: HTMLImageElement;\n  link: HTMLLinkElement;\n  script: HTMLScriptElement;\n  track: HTMLTrackElement;\n};\n\nexport type LoadableElementsNames = keyof LoadableElements;\n\nexport type LoadElementsOptions = {\n  /**\n   * An HTML element where the created element will be appended.\n   */\n  appendTo?: HTMLElement;\n};\n\nexport type LoadElementsReturnType<T extends LoadableElementsNames> = Promise<{\n  event: Event;\n  element: LoadableElements[T];\n}>;\n\n/**\n * Load the given source for the given type of element.\n * @todo manage memo\n */\nexport function loadElement<T extends LoadableElementsNames>(\n  src: string,\n  type: T,\n  { appendTo = null }: LoadElementsOptions = {},\n): LoadElementsReturnType<T> {\n  return new Promise((resolve, reject) => {\n    const eventOptions = { once: true };\n    const prop = type === 'link' ? 'href' : 'src';\n    const element = document.createElement(type);\n    element.addEventListener('load', (event) => resolve({ event, element }), eventOptions);\n    element.addEventListener('error', (event) => reject({ event, element }), eventOptions);\n    element[prop] = src;\n    if (appendTo) {\n      appendTo.append(element);\n    }\n  });\n}\n\n/**\n * Load the given source as an `<img>` element.\n */\nexport function loadImage(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'img', options);\n}\n\n/**\n * Load the given source as an `<iframe>` element.\n */\nexport function loadIframe(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'iframe', options);\n}\n\n/**\n * Load the given source as a `<link>` element.\n */\nexport function loadLink(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'link', options);\n}\n\n/**\n * Load the given source as a `<script>` element. The generated element is\n * appended to `document.head` by default, as a script element needs\n * to be inserted in the DOM to load.\n */\nexport function loadScript(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'script', { appendTo: document.head, ...options });\n}\n"],
-  "mappings": "AA2BO,SAAS,YACd,KACA,MACA,EAAE,WAAW,KAAK,IAAyB,CAAC,GACjB;AAC3B,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,eAAe,EAAE,MAAM,KAAK;AAClC,UAAM,OAAO,SAAS,SAAS,SAAS;AACxC,UAAM,UAAU,SAAS,cAAc,IAAI;AAC3C,YAAQ,iBAAiB,QAAQ,CAAC,UAAU,QAAQ,EAAE,OAAO,QAAQ,CAAC,GAAG,YAAY;AACrF,YAAQ,iBAAiB,SAAS,CAAC,UAAU,OAAO,EAAE,OAAO,QAAQ,CAAC,GAAG,YAAY;AACrF,YAAQ,IAAI,IAAI;AAChB,QAAI,UAAU;AACZ,eAAS,OAAO,OAAO;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAKO,SAAS,UAAU,KAAa,SAA+B;AACpE,SAAO,YAAY,KAAK,OAAO,OAAO;AACxC;AAKO,SAAS,WAAW,KAAa,SAA+B;AACrE,SAAO,YAAY,KAAK,UAAU,OAAO;AAC3C;AAKO,SAAS,SAAS,KAAa,SAA+B;AACnE,SAAO,YAAY,KAAK,QAAQ,OAAO;AACzC;AAOO,SAAS,WAAW,KAAa,SAA+B;AACrE,SAAO,YAAY,KAAK,UAAU,EAAE,UAAU,SAAS,MAAM,GAAG,QAAQ,CAAC;AAC3E;",
+  "sourcesContent": ["export type LoadableElements = {\n  embed: HTMLEmbedElement;\n  iframe: HTMLIFrameElement;\n  img: HTMLImageElement;\n  link: HTMLLinkElement;\n  script: HTMLScriptElement;\n  track: HTMLTrackElement;\n};\n\nexport type LoadableElementsNames = keyof LoadableElements;\n\nexport type LoadElementsOptions = {\n  /**\n   * An HTML element where the created element will be appended.\n   */\n  appendTo?: HTMLElement;\n};\n\nexport type LoadElementsReturnType<T extends LoadableElementsNames> = Promise<{\n  event: Event;\n  element: LoadableElements[T];\n}>;\n\n/**\n * Load the given source for the given type of element.\n * @todo manage memo\n * @link https://js-toolkit.studiometa.dev/utils/loadElement.html\n*/\nexport function loadElement<T extends LoadableElementsNames>(\n  src: string,\n  type: T,\n  { appendTo = null }: LoadElementsOptions = {},\n): LoadElementsReturnType<T> {\n  return new Promise((resolve, reject) => {\n    const eventOptions = { once: true };\n    const prop = type === 'link' ? 'href' : 'src';\n    const element = document.createElement(type);\n    element.addEventListener('load', (event) => resolve({ event, element }), eventOptions);\n    element.addEventListener('error', (event) => reject({ event, element }), eventOptions);\n    element[prop] = src;\n    if (appendTo) {\n      appendTo.append(element);\n    }\n  });\n}\n\n/**\n * Load the given source as an `<img>` element.\n * @link https://js-toolkit.studiometa.dev/utils/loadImage.html\n*/\nexport function loadImage(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'img', options);\n}\n\n/**\n * Load the given source as an `<iframe>` element.\n * @link https://js-toolkit.studiometa.dev/utils/loadIframe.html\n*/\nexport function loadIframe(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'iframe', options);\n}\n\n/**\n * Load the given source as a `<link>` element.\n * @link https://js-toolkit.studiometa.dev/utils/loadLink.html\n*/\nexport function loadLink(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'link', options);\n}\n\n/**\n * Load the given source as a `<script>` element. The generated element is\n * appended to `document.head` by default, as a script element needs\n * to be inserted in the DOM to load.\n * @link https://js-toolkit.studiometa.dev/utils/loadScript.html\n*/\nexport function loadScript(src: string, options?: LoadElementsOptions) {\n  return loadElement(src, 'script', { appendTo: document.head, ...options });\n}\n"],
+  "mappings": "AA4BO,SAAS,YACd,KACA,MACA,EAAE,WAAW,KAAK,IAAyB,CAAC,GACjB;AAC3B,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,eAAe,EAAE,MAAM,KAAK;AAClC,UAAM,OAAO,SAAS,SAAS,SAAS;AACxC,UAAM,UAAU,SAAS,cAAc,IAAI;AAC3C,YAAQ,iBAAiB,QAAQ,CAAC,UAAU,QAAQ,EAAE,OAAO,QAAQ,CAAC,GAAG,YAAY;AACrF,YAAQ,iBAAiB,SAAS,CAAC,UAAU,OAAO,EAAE,OAAO,QAAQ,CAAC,GAAG,YAAY;AACrF,YAAQ,IAAI,IAAI;AAChB,QAAI,UAAU;AACZ,eAAS,OAAO,OAAO;AAAA,IACzB;AAAA,EACF,CAAC;AACH;AAMO,SAAS,UAAU,KAAa,SAA+B;AACpE,SAAO,YAAY,KAAK,OAAO,OAAO;AACxC;AAMO,SAAS,WAAW,KAAa,SAA+B;AACrE,SAAO,YAAY,KAAK,UAAU,OAAO;AAC3C;AAMO,SAAS,SAAS,KAAa,SAA+B;AACnE,SAAO,YAAY,KAAK,QAAQ,OAAO;AACzC;AAQO,SAAS,WAAW,KAAa,SAA+B;AACrE,SAAO,YAAY,KAAK,UAAU,EAAE,UAAU,SAAS,MAAM,GAAG,QAAQ,CAAC;AAC3E;",
   "names": []
 }

package/utils/math/clamp.d.ts

@@ -1,9 +1,5 @@
 /**
  * Clamp a value in a given range.
- *
- * @param {number} value
- * @param {number} min
- * @param {number} max
- * @returns {number}
- */
+ * @link https://js-toolkit.studiometa.dev/utils/math/clamp.html
+*/
 export declare function clamp(value: number, min: number, max: number): number;

package/utils/math/clamp.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/clamp.ts"],
-  "sourcesContent": ["/**\n * Clamp a value in a given range.\n *\n * @param {number} value\n * @param {number} min\n * @param {number} max\n * @returns {number}\n */\nexport function clamp(value: number, min: number, max: number) {\n  /* eslint-disable no-nested-ternary */\n  return min < max\n    ? value < min\n      ? min\n      : value > max\n        ? max\n        : value\n    : value < max\n      ? max\n      : value > min\n        ? min\n        : value;\n  /* eslint-enable no-nested-ternary */\n}\n"],
-  "mappings": "AAQO,SAAS,MAAM,OAAe,KAAa,KAAa;AAE7D,SAAO,MAAM,MACT,QAAQ,MACN,MACA,QAAQ,MACN,MACA,QACJ,QAAQ,MACN,MACA,QAAQ,MACN,MACA;AAEV;",
+  "sourcesContent": ["/**\n * Clamp a value in a given range.\n * @link https://js-toolkit.studiometa.dev/utils/math/clamp.html\n*/\nexport function clamp(value: number, min: number, max: number) {\n  /* eslint-disable no-nested-ternary */\n  return min < max\n    ? value < min\n      ? min\n      : value > max\n        ? max\n        : value\n    : value < max\n      ? max\n      : value > min\n        ? min\n        : value;\n  /* eslint-enable no-nested-ternary */\n}\n"],
+  "mappings": "AAIO,SAAS,MAAM,OAAe,KAAa,KAAa;AAE7D,SAAO,MAAM,MACT,QAAQ,MACN,MACA,QAAQ,MACN,MACA,QACJ,QAAQ,MACN,MACA,QAAQ,MACN,MACA;AAEV;",
   "names": []
 }

package/utils/math/clamp01.d.ts

@@ -1,7 +1,5 @@
 /**
  * Clamp a value in the 0–1 range.
- *
- * @param {number} value
- * @returns {number}
- */
+ * @link https://js-toolkit.studiometa.dev/utils/math/clamp01.html
+*/
 export declare function clamp01(value: number): number;

package/utils/math/clamp01.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/clamp01.ts"],
-  "sourcesContent": ["import { clamp } from './clamp.js';\n\n/**\n * Clamp a value in the 0\u20131 range.\n *\n * @param {number} value\n * @returns {number}\n */\nexport function clamp01(value: number) {\n  return clamp(value, 0, 1);\n}\n"],
-  "mappings": "AAAA,SAAS,aAAa;AAQf,SAAS,QAAQ,OAAe;AACrC,SAAO,MAAM,OAAO,GAAG,CAAC;AAC1B;",
+  "sourcesContent": ["import { clamp } from './clamp.js';\n\n/**\n * Clamp a value in the 0\u20131 range.\n * @link https://js-toolkit.studiometa.dev/utils/math/clamp01.html\n*/\nexport function clamp01(value: number) {\n  return clamp(value, 0, 1);\n}\n"],
+  "mappings": "AAAA,SAAS,aAAa;AAMf,SAAS,QAAQ,OAAe;AACrC,SAAO,MAAM,OAAO,GAAG,CAAC;AAC1B;",
   "names": []
 }

package/utils/math/createEases.d.ts

@@ -1,15 +1,23 @@
+/**
+ * Easing function.
+ *
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ */
 export type EasingFunction = (progress: number) => number;
 /**
  * Create an out easing function.
  *
- * @param   {EasingFunction} easeIn The ease in function.
- * @returns {EasingFunction}        The out function.
- */
+ * @param  {EasingFunction} easeIn The ease in function.
+ * @return {EasingFunction}        The out function.
+ * @link https://js-toolkit.studiometa.dev/utils/math/createEaseOut.html
+*/
 export declare function createEaseOut(easeIn: EasingFunction): EasingFunction;
 /**
  * Create an in-out easing function.
  *
  * @param  {EasingFunction} easeIn The ease in function.
- * @returns {EasingFunction}        The in-out function.
- */
+ * @return {EasingFunction}        The in-out function.
+ * @link https://js-toolkit.studiometa.dev/utils/math/createEaseInOut.html
+*/
 export declare function createEaseInOut(easeIn: EasingFunction): EasingFunction;

package/utils/math/createEases.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/createEases.ts"],
-  "sourcesContent": ["export type EasingFunction = (progress: number) => number;\n\n/**\n * Create an out easing function.\n *\n * @param   {EasingFunction} easeIn The ease in function.\n * @returns {EasingFunction}        The out function.\n */\nexport function createEaseOut(easeIn: EasingFunction): EasingFunction {\n  return (progress) => 1 - easeIn(1 - progress);\n}\n\n/**\n * Create an in-out easing function.\n *\n * @param  {EasingFunction} easeIn The ease in function.\n * @returns {EasingFunction}        The in-out function.\n */\nexport function createEaseInOut(easeIn: EasingFunction): EasingFunction {\n  /* eslint-disable no-nested-ternary */\n  // eslint-disable-next-line no-confusing-arrow\n  return (progress) =>\n    progress === 0\n      ? 0\n      : progress === 1\n        ? 1\n        : progress < 0.5\n          ? easeIn(progress * 2) / 2\n          : 1 - easeIn((1 - progress) * 2) / 2;\n}\n"],
-  "mappings": "AAQO,SAAS,cAAc,QAAwC;AACpE,SAAO,CAAC,aAAa,IAAI,OAAO,IAAI,QAAQ;AAC9C;AAQO,SAAS,gBAAgB,QAAwC;AAGtE,SAAO,CAAC,aACN,aAAa,IACT,IACA,aAAa,IACX,IACA,WAAW,MACT,OAAO,WAAW,CAAC,IAAI,IACvB,IAAI,QAAQ,IAAI,YAAY,CAAC,IAAI;AAC7C;",
+  "sourcesContent": ["/**\n * Easing function.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n */\nexport type EasingFunction = (progress: number) => number;\n\n/**\n * Create an out easing function.\n *\n * @param  {EasingFunction} easeIn The ease in function.\n * @return {EasingFunction}        The out function.\n * @link https://js-toolkit.studiometa.dev/utils/math/createEaseOut.html\n*/\nexport function createEaseOut(easeIn: EasingFunction): EasingFunction {\n  return (progress) => 1 - easeIn(1 - progress);\n}\n\n/**\n * Create an in-out easing function.\n *\n * @param  {EasingFunction} easeIn The ease in function.\n * @return {EasingFunction}        The in-out function.\n * @link https://js-toolkit.studiometa.dev/utils/math/createEaseInOut.html\n*/\nexport function createEaseInOut(easeIn: EasingFunction): EasingFunction {\n  /* eslint-disable no-nested-ternary */\n  // eslint-disable-next-line no-confusing-arrow\n  return (progress) =>\n    progress === 0\n      ? 0\n      : progress === 1\n        ? 1\n        : progress < 0.5\n          ? easeIn(progress * 2) / 2\n          : 1 - easeIn((1 - progress) * 2) / 2;\n}\n"],
+  "mappings": "AAeO,SAAS,cAAc,QAAwC;AACpE,SAAO,CAAC,aAAa,IAAI,OAAO,IAAI,QAAQ;AAC9C;AASO,SAAS,gBAAgB,QAAwC;AAGtE,SAAO,CAAC,aACN,aAAa,IACT,IACA,aAAa,IACX,IACA,WAAW,MACT,OAAO,WAAW,CAAC,IAAI,IACvB,IAAI,QAAQ,IAAI,YAAY,CAAC,IAAI;AAC7C;",
   "names": []
 }

package/utils/math/createRange.d.ts

@@ -1,4 +1,5 @@
 /**
  * Create an array from a given range and with the given incremental step.
- */
+ * @link https://js-toolkit.studiometa.dev/utils/math/createRange.html
+*/
 export declare function createRange(min: number, max: number, step: number): number[];

package/utils/math/createRange.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/createRange.ts"],
-  "sourcesContent": ["/**\n * Create an array from a given range and with the given incremental step.\n */\nexport function createRange(min: number, max: number, step: number): number[] {\n  const result: number[] = [];\n  let value = min;\n\n  while (value <= max) {\n    result.push(value);\n    value += step;\n  }\n\n  return result;\n}\n"],
-  "mappings": "AAGO,SAAS,YAAY,KAAa,KAAa,MAAwB;AAC5E,QAAM,SAAmB,CAAC;AAC1B,MAAI,QAAQ;AAEZ,SAAO,SAAS,KAAK;AACnB,WAAO,KAAK,KAAK;AACjB,aAAS;AAAA,EACX;AAEA,SAAO;AACT;",
+  "sourcesContent": ["/**\n * Create an array from a given range and with the given incremental step.\n * @link https://js-toolkit.studiometa.dev/utils/math/createRange.html\n*/\nexport function createRange(min: number, max: number, step: number): number[] {\n  const result: number[] = [];\n  let value = min;\n\n  while (value <= max) {\n    result.push(value);\n    value += step;\n  }\n\n  return result;\n}\n"],
+  "mappings": "AAIO,SAAS,YAAY,KAAa,KAAa,MAAwB;AAC5E,QAAM,SAAmB,CAAC;AAC1B,MAAI,QAAQ;AAEZ,SAAO,SAAS,KAAK;AACnB,WAAO,KAAK,KAAK;AACjB,aAAS;AAAA,EACX;AAEA,SAAO;AACT;",
   "names": []
 }

package/utils/math/damp.d.ts

@@ -1,10 +1,11 @@
 /**
  * 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.
- * @returns {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, defaults to `0.5`.
+ * @param  {number} [precision=0.01] The precision used to calculate the latest value, defaults to `0.01`.
+ * @return {number} The next value.
+ * @link https://js-toolkit.studiometa.dev/utils/math/damp.html
+*/
 export declare function damp(targetValue: number, currentValue: number, factor?: number, precision?: number): number;

package/utils/math/damp.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/damp.ts"],
-  "sourcesContent": ["/**\n * Get the next damped value for a given factor.\n *\n * @param   {number} targetValue The final value.\n * @param   {number} currentValue The current value.\n * @param   {number} [factor=0.5] The factor used to reach the target value.\n * @param   {number} [precision=0.01] The precision used to calculate the latest value.\n * @returns {number} The next value.\n */\nexport function damp(\n  targetValue: number,\n  currentValue: number,\n  factor = 0.5,\n  precision = 0.01,\n) {\n  return Math.abs(targetValue - currentValue) < precision\n    ? targetValue\n    : currentValue + (targetValue - currentValue) * factor;\n}\n"],
-  "mappings": "AASO,SAAS,KACd,aACA,cACA,SAAS,KACT,YAAY,MACZ;AACA,SAAO,KAAK,IAAI,cAAc,YAAY,IAAI,YAC1C,cACA,gBAAgB,cAAc,gBAAgB;AACpD;",
+  "sourcesContent": ["/**\n * Get the next damped value for a given factor.\n *\n * @param  {number} targetValue The final value.\n * @param  {number} currentValue The current value.\n * @param  {number} [factor=0.5] The factor used to reach the target value, defaults to `0.5`.\n * @param  {number} [precision=0.01] The precision used to calculate the latest value, defaults to `0.01`.\n * @return {number} The next value.\n * @link https://js-toolkit.studiometa.dev/utils/math/damp.html\n*/\nexport function damp(\n  targetValue: number,\n  currentValue: number,\n  factor = 0.5,\n  precision = 0.01,\n) {\n  return Math.abs(targetValue - currentValue) < precision\n    ? targetValue\n    : currentValue + (targetValue - currentValue) * factor;\n}\n"],
+  "mappings": "AAUO,SAAS,KACd,aACA,cACA,SAAS,KACT,YAAY,MACZ;AACA,SAAO,KAAK,IAAI,cAAc,YAAY,IAAI,YAC1C,cACA,gBAAgB,cAAc,gBAAgB;AACpD;",
   "names": []
 }

package/utils/math/ease.d.ts

@@ -1,7 +1,10 @@
 export { noopValue as easeLinear } from '../noop.js';
 /**
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * Ease in quad.
+ *
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInQuad(progress: number): number;
 export declare const easeOutQuad: import("./createEases.js").EasingFunction;
@@ -9,8 +12,9 @@ export declare const easeInOutQuad: import("./createEases.js").EasingFunction;
 /**
  * Ease in cubic.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInCubic(progress: number): number;
 export declare const easeOutCubic: import("./createEases.js").EasingFunction;
@@ -18,8 +22,9 @@ export declare const easeInOutCubic: import("./createEases.js").EasingFunction;
 /**
  * Ease in quart.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInQuart(progress: number): number;
 export declare const easeOutQuart: import("./createEases.js").EasingFunction;
@@ -27,8 +32,9 @@ export declare const easeInOutQuart: import("./createEases.js").EasingFunction;
 /**
  * Ease in quint.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInQuint(progress: number): number;
 export declare const easeOutQuint: import("./createEases.js").EasingFunction;
@@ -36,8 +42,9 @@ export declare const easeInOutQuint: import("./createEases.js").EasingFunction;
 /**
  * Ease in sine.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInSine(progress: number): number;
 export declare const easeOutSine: import("./createEases.js").EasingFunction;
@@ -45,8 +52,9 @@ export declare const easeInOutSine: import("./createEases.js").EasingFunction;
 /**
  * Ease in circ.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInCirc(progress: number): number;
 export declare const easeOutCirc: import("./createEases.js").EasingFunction;
@@ -54,8 +62,9 @@ export declare const easeInOutCirc: import("./createEases.js").EasingFunction;
 /**
  * Ease in exponential.
  *
- * @param  {number} progress Progress value betwen 0 and 1.
- * @returns {number}          Eased value between 0 and 1.
+ * @param  progress Progress value betwen `0` and `1`.
+ * @return          Eased value between `0` and `1`.
+ * @link https://js-toolkit.studiometa.dev/utils/math/ease.html
  */
 export declare function easeInExpo(progress: number): number;
 export declare const easeOutExpo: import("./createEases.js").EasingFunction;

package/utils/math/ease.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/ease.ts"],
-  "sourcesContent": ["import { createEaseOut, createEaseInOut } from './createEases.js';\n\nexport { noopValue as easeLinear } from '../noop.js';\n\n/**\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInQuad(progress: number) {\n  return progress ** 2;\n}\n\nexport const easeOutQuad = createEaseOut(easeInQuad);\nexport const easeInOutQuad = createEaseInOut(easeInQuad);\n\n/**\n * Ease in cubic.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInCubic(progress: number) {\n  return progress ** 3;\n}\n\nexport const easeOutCubic = createEaseOut(easeInCubic);\nexport const easeInOutCubic = createEaseInOut(easeInCubic);\n\n/**\n * Ease in quart.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInQuart(progress: number) {\n  return progress ** 4;\n}\n\nexport const easeOutQuart = createEaseOut(easeInQuart);\nexport const easeInOutQuart = createEaseInOut(easeInQuart);\n\n/**\n * Ease in quint.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInQuint(progress: number) {\n  return progress ** 5;\n}\n\nexport const easeOutQuint = createEaseOut(easeInQuint);\nexport const easeInOutQuint = createEaseInOut(easeInQuint);\n\n/**\n * Ease in sine.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInSine(progress: number) {\n  return progress === 1 ? 1 : -Math.cos((progress * Math.PI) / 2) + 1;\n}\n\nexport const easeOutSine = createEaseOut(easeInSine);\nexport const easeInOutSine = createEaseInOut(easeInSine);\n\n/**\n * Ease in circ.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInCirc(progress: number) {\n  return -(Math.sqrt(1 - progress * progress) - 1);\n}\n\nexport const easeOutCirc = createEaseOut(easeInCirc);\nexport const easeInOutCirc = createEaseInOut(easeInCirc);\n\n/**\n * Ease in exponential.\n *\n * @param  {number} progress Progress value betwen 0 and 1.\n * @returns {number}          Eased value between 0 and 1.\n */\nexport function easeInExpo(progress: number) {\n  return progress === 0 ? 0 : 2 ** (10 * (progress - 1));\n}\n\nexport const easeOutExpo = createEaseOut(easeInExpo);\nexport const easeInOutExpo = createEaseInOut(easeInExpo);\n"],
-  "mappings": "AAAA,SAAS,eAAe,uBAAuB;AAE/C,SAAsB,iBAAkB;AAMjC,SAAS,WAAW,UAAkB;AAC3C,SAAO,YAAY;AACrB;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAQhD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AAQlD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AAQlD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AAQlD,SAAS,WAAW,UAAkB;AAC3C,SAAO,aAAa,IAAI,IAAI,CAAC,KAAK,IAAK,WAAW,KAAK,KAAM,CAAC,IAAI;AACpE;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAQhD,SAAS,WAAW,UAAkB;AAC3C,SAAO,EAAE,KAAK,KAAK,IAAI,WAAW,QAAQ,IAAI;AAChD;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAQhD,SAAS,WAAW,UAAkB;AAC3C,SAAO,aAAa,IAAI,IAAI,MAAM,MAAM,WAAW;AACrD;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;",
+  "sourcesContent": ["import { createEaseOut, createEaseInOut } from './createEases.js';\n\nexport { noopValue as easeLinear } from '../noop.js';\n\n/**\n * Ease in quad.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInQuad(progress: number) {\n  return progress ** 2;\n}\n\nexport const easeOutQuad = createEaseOut(easeInQuad);\nexport const easeInOutQuad = createEaseInOut(easeInQuad);\n\n/**\n * Ease in cubic.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInCubic(progress: number) {\n  return progress ** 3;\n}\n\nexport const easeOutCubic = createEaseOut(easeInCubic);\nexport const easeInOutCubic = createEaseInOut(easeInCubic);\n\n/**\n * Ease in quart.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInQuart(progress: number) {\n  return progress ** 4;\n}\n\nexport const easeOutQuart = createEaseOut(easeInQuart);\nexport const easeInOutQuart = createEaseInOut(easeInQuart);\n\n/**\n * Ease in quint.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInQuint(progress: number) {\n  return progress ** 5;\n}\n\nexport const easeOutQuint = createEaseOut(easeInQuint);\nexport const easeInOutQuint = createEaseInOut(easeInQuint);\n\n/**\n * Ease in sine.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInSine(progress: number) {\n  return progress === 1 ? 1 : -Math.cos((progress * Math.PI) / 2) + 1;\n}\n\nexport const easeOutSine = createEaseOut(easeInSine);\nexport const easeInOutSine = createEaseInOut(easeInSine);\n\n/**\n * Ease in circ.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInCirc(progress: number) {\n  return -(Math.sqrt(1 - progress * progress) - 1);\n}\n\nexport const easeOutCirc = createEaseOut(easeInCirc);\nexport const easeInOutCirc = createEaseInOut(easeInCirc);\n\n/**\n * Ease in exponential.\n *\n * @param  progress Progress value betwen `0` and `1`.\n * @return          Eased value between `0` and `1`.\n * @link https://js-toolkit.studiometa.dev/utils/math/ease.html\n */\nexport function easeInExpo(progress: number) {\n  return progress === 0 ? 0 : 2 ** (10 * (progress - 1));\n}\n\nexport const easeOutExpo = createEaseOut(easeInExpo);\nexport const easeInOutExpo = createEaseInOut(easeInExpo);\n"],
+  "mappings": "AAAA,SAAS,eAAe,uBAAuB;AAE/C,SAAsB,iBAAkB;AASjC,SAAS,WAAW,UAAkB;AAC3C,SAAO,YAAY;AACrB;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAShD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AASlD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AASlD,SAAS,YAAY,UAAkB;AAC5C,SAAO,YAAY;AACrB;AAEO,MAAM,eAAe,cAAc,WAAW;AAC9C,MAAM,iBAAiB,gBAAgB,WAAW;AASlD,SAAS,WAAW,UAAkB;AAC3C,SAAO,aAAa,IAAI,IAAI,CAAC,KAAK,IAAK,WAAW,KAAK,KAAM,CAAC,IAAI;AACpE;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAShD,SAAS,WAAW,UAAkB;AAC3C,SAAO,EAAE,KAAK,KAAK,IAAI,WAAW,QAAQ,IAAI;AAChD;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;AAShD,SAAS,WAAW,UAAkB;AAC3C,SAAO,aAAa,IAAI,IAAI,MAAM,MAAM,WAAW;AACrD;AAEO,MAAM,cAAc,cAAc,UAAU;AAC5C,MAAM,gBAAgB,gBAAgB,UAAU;",
   "names": []
 }

package/utils/math/inertiaFinalValue.d.ts

@@ -1,9 +1,10 @@
 /**
  * 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.
- * @returns {number} The next value.
- */
+ * @param   initialValue The final value.
+ * @param   initialDelta The current value.
+ * @param   [dampFactor=0.85] The speed to reach the target value, defaults to `0.85`.
+ * @returns The next value.
+ * @link https://js-toolkit.studiometa.dev/utils/math/inertiaFinalValue.html
+*/
 export declare function inertiaFinalValue(initialValue: number, initialDelta: number, dampFactor?: number): number;

package/utils/math/inertiaFinalValue.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/inertiaFinalValue.ts"],
-  "sourcesContent": ["import { clamp } from './clamp.js';\n\n/**\n * Get the final damped value for a given factor.\n *\n * @param   {number} initialValue The final value.\n * @param   {number} initialDelta The current value.\n * @param   {number} [dampFactor=0.85] The speed to reach the target value.\n * @returns {number} The next value.\n */\nexport function inertiaFinalValue(initialValue: number, initialDelta: number, dampFactor = 0.85) {\n  // eslint-disable-next-line no-param-reassign\n  dampFactor = clamp(dampFactor, 0.00001, 0.99999);\n  let delta = initialDelta;\n  let finalValue = initialValue;\n\n  while (Math.abs(delta) > 0.1) {\n    finalValue += delta;\n    delta *= dampFactor;\n  }\n\n  return finalValue;\n}\n"],
-  "mappings": "AAAA,SAAS,aAAa;AAUf,SAAS,kBAAkB,cAAsB,cAAsB,aAAa,MAAM;AAE/F,eAAa,MAAM,YAAY,MAAS,OAAO;AAC/C,MAAI,QAAQ;AACZ,MAAI,aAAa;AAEjB,SAAO,KAAK,IAAI,KAAK,IAAI,KAAK;AAC5B,kBAAc;AACd,aAAS;AAAA,EACX;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { clamp } from './clamp.js';\n\n/**\n * Get the final damped value for a given factor.\n *\n * @param   initialValue The final value.\n * @param   initialDelta The current value.\n * @param   [dampFactor=0.85] The speed to reach the target value, defaults to `0.85`.\n * @returns The next value.\n * @link https://js-toolkit.studiometa.dev/utils/math/inertiaFinalValue.html\n*/\nexport function inertiaFinalValue(initialValue: number, initialDelta: number, dampFactor = 0.85) {\n  // eslint-disable-next-line no-param-reassign\n  dampFactor = clamp(dampFactor, 0.00001, 0.99999);\n  let delta = initialDelta;\n  let finalValue = initialValue;\n\n  while (Math.abs(delta) > 0.1) {\n    finalValue += delta;\n    delta *= dampFactor;\n  }\n\n  return finalValue;\n}\n"],
+  "mappings": "AAAA,SAAS,aAAa;AAWf,SAAS,kBAAkB,cAAsB,cAAsB,aAAa,MAAM;AAE/F,eAAa,MAAM,YAAY,MAAS,OAAO;AAC/C,MAAI,QAAQ;AACZ,MAAI,aAAa;AAEjB,SAAO,KAAK,IAAI,KAAK,IAAI,KAAK;AAC5B,kBAAc;AACd,aAAS;AAAA,EACX;AAEA,SAAO;AACT;",
   "names": []
 }

package/utils/math/lerp.d.ts

@@ -1,9 +1,10 @@
 /**
  * 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.
- * @returns {number}       The value between min and max corresponding to ratio.
- */
+ * @param  min   The interval minimum value.
+ * @param  max   The inverval maximum value.
+ * @param  ratio The ratio to get.
+ * @return       The value between min and max corresponding to ratio.
+ * @link https://js-toolkit.studiometa.dev/utils/math/lerp.html
+*/
 export declare function lerp(min: number, max: number, ratio: number): number;

package/utils/math/lerp.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/lerp.ts"],
-  "sourcesContent": ["/**\n * Interpolate the ratio between a given interval.\n *\n * @param  {number} min   The interval minimum value.\n * @param  {number} max   The inverval maximum value.\n * @param  {number} ratio The ratio to get.\n * @returns {number}       The value between min and max corresponding to ratio.\n */\nexport function lerp(min: number, max: number, ratio: number) {\n  return (1 - ratio) * min + ratio * max;\n}\n"],
-  "mappings": "AAQO,SAAS,KAAK,KAAa,KAAa,OAAe;AAC5D,UAAQ,IAAI,SAAS,MAAM,QAAQ;AACrC;",
+  "sourcesContent": ["/**\n * Interpolate the ratio between a given interval.\n *\n * @param  min   The interval minimum value.\n * @param  max   The inverval maximum value.\n * @param  ratio The ratio to get.\n * @return       The value between min and max corresponding to ratio.\n * @link https://js-toolkit.studiometa.dev/utils/math/lerp.html\n*/\nexport function lerp(min: number, max: number, ratio: number) {\n  return (1 - ratio) * min + ratio * max;\n}\n"],
+  "mappings": "AASO,SAAS,KAAK,KAAa,KAAa,OAAe;AAC5D,UAAQ,IAAI,SAAS,MAAM,QAAQ;AACrC;",
   "names": []
 }

package/utils/math/map.d.ts

@@ -6,6 +6,7 @@
  * @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.
- */
+ * @return {number}           The input value mapped to the output range.
+ * @link https://js-toolkit.studiometa.dev/utils/math/map.html
+*/
 export declare function map(value: number, inputMin: number, inputMax: number, outputMin: number, outputMax: number): number;

package/utils/math/map.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../packages/js-toolkit/utils/math/map.ts"],
-  "sourcesContent": ["/**\n * Maps the value from one range of [inputMin..inputMax] to another range of [outputMin..outputMax].\n *\n * @param  {number} value     The value to map.\n * @param  {number} inputMin  The input's minimum value.\n * @param  {number} inputMax  The input's maximum value.\n * @param  {number} outputMin The output's minimum value.\n * @param  {number} outputMax The output's maximum value.\n * @returns {number}           The input value mapped to the output range.\n */\nexport function map(\n  value: number,\n  inputMin: number,\n  inputMax: number,\n  outputMin: number,\n  outputMax: number,\n) {\n  return ((value - inputMin) * (outputMax - outputMin)) / (inputMax - inputMin) + outputMin;\n}\n"],
-  "mappings": "AAUO,SAAS,IACd,OACA,UACA,UACA,WACA,WACA;AACA,UAAS,QAAQ,aAAa,YAAY,cAAe,WAAW,YAAY;AAClF;",
+  "sourcesContent": ["/**\n * Maps the value from one range of [inputMin..inputMax] to another range of [outputMin..outputMax].\n *\n * @param  {number} value     The value to map.\n * @param  {number} inputMin  The input's minimum value.\n * @param  {number} inputMax  The input's maximum value.\n * @param  {number} outputMin The output's minimum value.\n * @param  {number} outputMax The output's maximum value.\n * @return {number}           The input value mapped to the output range.\n * @link https://js-toolkit.studiometa.dev/utils/math/map.html\n*/\nexport function map(\n  value: number,\n  inputMin: number,\n  inputMax: number,\n  outputMin: number,\n  outputMax: number,\n) {\n  return ((value - inputMin) * (outputMax - outputMin)) / (inputMax - inputMin) + outputMin;\n}\n"],
+  "mappings": "AAWO,SAAS,IACd,OACA,UACA,UACA,WACA,WACA;AACA,UAAS,QAAQ,aAAa,YAAY,cAAe,WAAW,YAAY;AAClF;",
   "names": []
 }

package/utils/math/mean.d.ts

@@ -1 +1,4 @@
+/**
+ * @link https://js-toolkit.studiometa.dev/utils/math/mean.html
+ */
 export declare function mean(numbers: number[]): number;