@ntnyq/utils 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -183,7 +183,7 @@ declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?:
 *
 * @returns boolean - true if the code is running in a browser
 */
-declare const isBrowser: () => boolean;
+declare function isBrowser(): boolean;
 //#endregion
 //#region src/file/removeExtension.d.ts
 /**
@@ -205,6 +205,10 @@ declare function escapeHTML(str: string): string;
 declare function unescapeHTML(str: string): string;
 //#endregion
 //#region src/misc/raf.d.ts
+/**
+* Gets the global root object.
+* @returns the global root object
+*/
 declare function getRoot(): Window | typeof globalThis;
 /**
 * Request animation frame
@@ -226,15 +230,35 @@ declare function cAF(id: number): void;
 * @file time utils
 * @module Time
 */
-declare const ONE_SECOND_MILLSECONDS: number;
-declare const ONE_MINUTE_MILLSECONDS: number;
-declare const ONE_HOUR_MILLSECONDS: number;
-declare const ONE_DAY_MILLSECONDS: number;
-declare const ONE_WEEK_MILLSECONDS: number;
+/**
+* Converts seconds to milliseconds.
+* @param count - The number of seconds.
+* @returns The equivalent number of milliseconds.
+*/
 declare function seconds(count: number): number;
+/**
+* Converts minutes to milliseconds.
+* @param count - The number of minutes.
+* @returns The equivalent number of milliseconds.
+*/
 declare function minutes(count: number): number;
+/**
+* Converts hours to milliseconds.
+* @param count - The number of hours.
+* @returns The equivalent number of milliseconds.
+*/
 declare function hours(count: number): number;
+/**
+* Converts days to milliseconds.
+* @param count - The number of days.
+* @returns The equivalent number of milliseconds.
+*/
 declare function days(count: number): number;
+/**
+* Converts weeks to milliseconds.
+* @param count - The number of weeks.
+* @returns The equivalent number of milliseconds.
+*/
 declare function weeks(count: number): number;
 //#endregion
 //#region src/misc/clamp.d.ts
@@ -747,4 +771,4 @@ declare const RE_LINE_COMMENT: RegExp;
 */
 declare const RE_BLOCK_COMMENT: RegExp;
 //#endregion
-export { AnyFn, Arrayable, Awaitable, Callable, CleanObjectOptions, Color, CreatePadStringOptions, DeepRequired, GetStringSimilarityOptions, InteropModuleDefault, JsonArray, JsonObject, JsonPrimitive, JsonValue, LiteralUnion, MayBe, Merge, NOOP, NonEmptyObject, NonEmptyString, Nullable, ONE_DAY_MILLSECONDS, ONE_HOUR_MILLSECONDS, ONE_MINUTE_MILLSECONDS, ONE_SECOND_MILLSECONDS, ONE_WEEK_MILLSECONDS, OpenExternalURLOptions, Overwrite, Prettify, PrettifyV2, Primitive, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, RamdomNumberOptions, ResolvedOptions, SPECIAL_CHAR, SortObjectOptions, ThrottleDebounceOptions, ToIntegerOptions, Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { AnyFn, Arrayable, Awaitable, Callable, CleanObjectOptions, Color, CreatePadStringOptions, DeepRequired, GetStringSimilarityOptions, InteropModuleDefault, JsonArray, JsonObject, JsonPrimitive, JsonValue, LiteralUnion, MayBe, Merge, NOOP, NonEmptyObject, NonEmptyString, Nullable, OpenExternalURLOptions, Overwrite, Prettify, PrettifyV2, Primitive, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, RamdomNumberOptions, ResolvedOptions, SPECIAL_CHAR, SortObjectOptions, ThrottleDebounceOptions, ToIntegerOptions, Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -221,7 +221,9 @@ function isElementVisibleInViewport(element, targetWindow = window) {
 *
 * @returns boolean - true if the code is running in a browser
 */
-const isBrowser = () => typeof document !== "undefined";
+function isBrowser() {
+	return typeof document !== "undefined";
+}
 
 //#endregion
 //#region src/file/removeExtension.ts
@@ -273,17 +275,13 @@ function unescapeHTML(str) {
 
 //#endregion
 //#region src/misc/raf.ts
+/**
+* Gets the global root object.
+* @returns the global root object
+*/
 function getRoot() {
 	return isBrowser() ? window : globalThis;
 }
-let prev = Date.now();
-function mockRAF(fn) {
-	const curr = Date.now();
-	const ms = Math.max(0, 16 - (curr - prev));
-	const id = setTimeout(fn, ms);
-	prev = curr + ms;
-	return id;
-}
 /**
 * Request animation frame
 *
@@ -292,7 +290,7 @@ function mockRAF(fn) {
 */
 function rAF(fn) {
 	const root = getRoot();
-	const raf = root.requestAnimationFrame || mockRAF;
+	const raf = root.requestAnimationFrame;
 	return raf.call(root, fn);
 }
 /**
@@ -303,7 +301,7 @@ function rAF(fn) {
 */
 function cAF(id) {
 	const root = getRoot();
-	const caf = root.cancelAnimationFrame || root.clearTimeout;
+	const caf = root.cancelAnimationFrame;
 	return caf.call(root, id);
 }
 
@@ -313,25 +311,45 @@ function cAF(id) {
 * @file time utils
 * @module Time
 */
-const ONE_SECOND_MILLSECONDS = 1e3;
-const ONE_MINUTE_MILLSECONDS = 60 * 1e3;
-const ONE_HOUR_MILLSECONDS = 60 * 60 * 1e3;
-const ONE_DAY_MILLSECONDS = 24 * 60 * 60 * 1e3;
-const ONE_WEEK_MILLSECONDS = 7 * 24 * 60 * 60 * 1e3;
+/**
+* Converts seconds to milliseconds.
+* @param count - The number of seconds.
+* @returns The equivalent number of milliseconds.
+*/
 function seconds(count) {
-	return count * ONE_SECOND_MILLSECONDS;
+	return count * 1e3;
 }
+/**
+* Converts minutes to milliseconds.
+* @param count - The number of minutes.
+* @returns The equivalent number of milliseconds.
+*/
 function minutes(count) {
-	return count * ONE_MINUTE_MILLSECONDS;
+	return count * 60 * 1e3;
 }
+/**
+* Converts hours to milliseconds.
+* @param count - The number of hours.
+* @returns The equivalent number of milliseconds.
+*/
 function hours(count) {
-	return count * ONE_HOUR_MILLSECONDS;
+	return count * 60 * 60 * 1e3;
 }
+/**
+* Converts days to milliseconds.
+* @param count - The number of days.
+* @returns The equivalent number of milliseconds.
+*/
 function days(count) {
-	return count * ONE_DAY_MILLSECONDS;
+	return count * 24 * 60 * 60 * 1e3;
 }
+/**
+* Converts weeks to milliseconds.
+* @param count - The number of weeks.
+* @returns The equivalent number of milliseconds.
+*/
 function weeks(count) {
-	return count * ONE_WEEK_MILLSECONDS;
+	return count * 7 * 24 * 60 * 60 * 1e3;
 }
 
 //#endregion
@@ -1065,4 +1083,4 @@ const RE_LINE_COMMENT = /\/\/.*/;
 const RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
 
 //#endregion
-export { Color, NOOP, ONE_DAY_MILLSECONDS, ONE_HOUR_MILLSECONDS, ONE_MINUTE_MILLSECONDS, ONE_SECOND_MILLSECONDS, ONE_WEEK_MILLSECONDS, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, SPECIAL_CHAR, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { Color, NOOP, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, SPECIAL_CHAR, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Common used utils.",
   "keywords": [
     "utils"