@studiometa/js-toolkit 2.0.0-rc.1 → 2.0.1

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;
     }