@ocavue/utils 0.4.0 → 0.6.0

package/README.md

@@ -4,6 +4,10 @@
 
 A collection of utility functions.
 
+## [API Reference](https://doc.deno.land/https://esm.sh/@ocavue/utils)
+
+## [Changelog](https://github.com/ocavue/utils/releases)
+
 ## License
 
 MIT

package/dist/index.d.ts

@@ -1,15 +1,87 @@
-export { isObject_alias_1 as isObject } from './_tsup-dts-rollup.js';
-export { isElement_alias_1 as isElement } from './_tsup-dts-rollup.js';
-export { isTextNode_alias_1 as isTextNode } from './_tsup-dts-rollup.js';
-export { isHTMLElement_alias_1 as isHTMLElement } from './_tsup-dts-rollup.js';
-export { isSVGElement_alias_1 as isSVGElement } from './_tsup-dts-rollup.js';
-export { isMathMLElement_alias_1 as isMathMLElement } from './_tsup-dts-rollup.js';
-export { isDocument_alias_1 as isDocument } from './_tsup-dts-rollup.js';
-export { isDocumentFragment_alias_1 as isDocumentFragment } from './_tsup-dts-rollup.js';
-export { isShadowRoot_alias_1 as isShadowRoot } from './_tsup-dts-rollup.js';
-export { isNodeLike_alias_1 as isNodeLike } from './_tsup-dts-rollup.js';
-export { isElementLike_alias_1 as isElementLike } from './_tsup-dts-rollup.js';
-export { isWindowLike_alias_1 as isWindowLike } from './_tsup-dts-rollup.js';
-export { getWindow_alias_1 as getWindow } from './_tsup-dts-rollup.js';
-export { getDocument_alias_1 as getDocument } from './_tsup-dts-rollup.js';
-export { getDocumentElement_alias_1 as getDocumentElement } from './_tsup-dts-rollup.js';
+/**
+ * Checks if the given value is an object.
+ */
+declare function isObject(value: unknown): value is Record<string | symbol | number, unknown>;
+
+/**
+ * Checks if the given DOM node is an Element.
+ */
+declare function isElement(node: Node): node is Element;
+/**
+ * Checks if the given DOM node is a Text node.
+ */
+declare function isTextNode(node: Node): node is Text;
+/**
+ * Checks if the given DOM node is an HTMLElement.
+ */
+declare function isHTMLElement(node: Node): node is HTMLElement;
+/**
+ * Checks if the given DOM node is an SVGElement.
+ */
+declare function isSVGElement(node: Node): node is SVGElement;
+/**
+ * Checks if the given DOM node is an MathMLElement.
+ */
+declare function isMathMLElement(node: Node): node is MathMLElement;
+/**
+ * Checks if the given DOM node is a Document.
+ */
+declare function isDocument(node: Node): node is Document;
+/**
+ * Checks if the given DOM node is a DocumentFragment.
+ */
+declare function isDocumentFragment(node: Node): node is DocumentFragment;
+/**
+ * Checks if the given DOM node is a ShadowRoot.
+ */
+declare function isShadowRoot(node: Node): node is ShadowRoot;
+/**
+ * Checks if an unknown value is likely a DOM node.
+ */
+declare function isNodeLike(value: unknown): value is Node;
+/**
+ * Checks if an unknown value is likely a DOM element.
+ */
+declare function isElementLike(value: unknown): value is Element;
+/**
+ * Checks if the given value is likely a Window object.
+ */
+declare function isWindowLike(value: unknown): value is Window;
+/**
+ * Gets the window object for the given target or the global window object if no
+ * target is provided.
+ */
+declare function getWindow(target?: Node | ShadowRoot | Document | null): Window & typeof globalThis;
+/**
+ * Gets the document for the given target or the global document if no target is
+ * provided.
+ */
+declare function getDocument(target?: Element | Window | Node | Document | null): Document;
+/**
+ * Gets a reference to the root node of the document based on the given target.
+ */
+declare function getDocumentElement(target?: Element | Node | Window | Document | null): HTMLElement;
+
+/**
+ * Creates a function that will only execute the provided function once.
+ * Subsequent calls will return the cached result from the first execution.
+ *
+ * @param fn The function to execute once
+ * @returns A function that will only execute the provided function once
+ * @example
+ * ```ts
+ * const getValue = once(() => expensiveOperation())
+ * getValue() // executes expensiveOperation
+ * getValue() // returns cached result
+ * ```
+ */
+declare function once<T>(fn: () => T): () => T;
+
+/**
+ * Formats a number of bytes into a human-readable string.
+ * @param bytes - The number of bytes to format.
+ * @returns A string representing the number of bytes in a human-readable format.
+ */
+declare function formatBytes(bytes: number): string;
+
+export { formatBytes, getDocument, getDocumentElement, getWindow, isDocument, isDocumentFragment, isElement, isElementLike, isHTMLElement, isMathMLElement, isNodeLike, isObject, isSVGElement, isShadowRoot, isTextNode, isWindowLike, once };

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/checker.ts
 function isObject(value) {
-  return value != null && typeof value === "object" && Array.isArray(value) === false;
+  return value != null && typeof value === "object";
 }
 
 // src/dom.ts
@@ -66,7 +66,35 @@ function getDocument(target) {
 function getDocumentElement(target) {
   return getDocument(target).documentElement;
 }
+
+// src/once.ts
+function once(fn) {
+  let called = false;
+  let result;
+  return () => {
+    if (!called) {
+      result = fn();
+      called = true;
+      fn = void 0;
+    }
+    return result;
+  };
+}
+
+// src/format-bytes.ts
+function formatBytes(bytes) {
+  const units = ["B", "KB", "MB", "GB"];
+  let unitIndex = 0;
+  let num = bytes;
+  while (Math.abs(num) >= 1024 && unitIndex < units.length - 1) {
+    num /= 1024;
+    unitIndex++;
+  }
+  const fraction = unitIndex === 0 && num % 1 === 0 ? 0 : 1;
+  return `${num.toFixed(fraction)}${units[unitIndex]}`;
+}
 export {
+  formatBytes,
   getDocument,
   getDocumentElement,
   getWindow,
@@ -81,5 +109,6 @@ export {
   isSVGElement,
   isShadowRoot,
   isTextNode,
-  isWindowLike
+  isWindowLike,
+  once
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/utils",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -36,21 +36,27 @@
     "dist"
   ],
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.2",
-    "@ocavue/eslint-config": "^2.13.1",
-    "@ocavue/tsconfig": "^0.2.0",
+    "@ocavue/eslint-config": "^3.2.0",
+    "@ocavue/tsconfig": "^0.3.7",
+    "@size-limit/preset-small-lib": "^11.2.0",
     "@types/node": "^20.17.27",
-    "eslint": "^9.23.0",
-    "jsdom": "^26.0.0",
-    "prettier": "^3.5.3",
-    "tsup": "^8.4.0",
-    "typescript": "^5.7.2",
-    "vite": "^6.0.12",
-    "vitest": "^3.0.9"
+    "eslint": "^9.31.0",
+    "jsdom": "^26.1.0",
+    "prettier": "^3.6.2",
+    "size-limit": "^11.2.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.5",
+    "vitest": "^3.2.4"
   },
   "publishConfig": {
     "access": "public"
   },
+  "size-limit": [
+    {
+      "path": "dist/index.js"
+    }
+  ],
   "renovate": {
     "extends": [
       "github>ocavue/config-renovate"

package/dist/_tsup-dts-rollup.d.ts

@@ -1,105 +0,0 @@
-/**
- * Gets the document for the given target or the global document if no target is
- * provided.
- */
-declare function getDocument(target?: Element | Window | Node | Document | null | undefined): Document;
-export { getDocument }
-export { getDocument as getDocument_alias_1 }
-
-/**
- * Gets a reference to the root node of the document based on the given target.
- */
-declare function getDocumentElement(target?: Element | Node | Window | Document | null | undefined): HTMLElement;
-export { getDocumentElement }
-export { getDocumentElement as getDocumentElement_alias_1 }
-
-/**
- * Gets the window object for the given target or the global window object if no
- * target is provided.
- */
-declare function getWindow(target?: Node | ShadowRoot | Document | null | undefined): Window & typeof globalThis;
-export { getWindow }
-export { getWindow as getWindow_alias_1 }
-
-/**
- * Checks if the given DOM node is a Document.
- */
-declare function isDocument(node: Node): node is Document;
-export { isDocument }
-export { isDocument as isDocument_alias_1 }
-
-/**
- * Checks if the given DOM node is a DocumentFragment.
- */
-declare function isDocumentFragment(node: Node): node is DocumentFragment;
-export { isDocumentFragment }
-export { isDocumentFragment as isDocumentFragment_alias_1 }
-
-/**
- * Checks if the given DOM node is an Element.
- */
-declare function isElement(node: Node): node is Element;
-export { isElement }
-export { isElement as isElement_alias_1 }
-
-/**
- * Checks if an unknown value is likely a DOM element.
- */
-declare function isElementLike(value: unknown): value is Element;
-export { isElementLike }
-export { isElementLike as isElementLike_alias_1 }
-
-/**
- * Checks if the given DOM node is an HTMLElement.
- */
-declare function isHTMLElement(node: Node): node is HTMLElement;
-export { isHTMLElement }
-export { isHTMLElement as isHTMLElement_alias_1 }
-
-/**
- * Checks if the given DOM node is an MathMLElement.
- */
-declare function isMathMLElement(node: Node): node is MathMLElement;
-export { isMathMLElement }
-export { isMathMLElement as isMathMLElement_alias_1 }
-
-/**
- * Checks if an unknown value is likely a DOM node.
- */
-declare function isNodeLike(value: unknown): value is Node;
-export { isNodeLike }
-export { isNodeLike as isNodeLike_alias_1 }
-
-declare function isObject(value: unknown): value is Record<string | symbol | number, unknown>;
-export { isObject }
-export { isObject as isObject_alias_1 }
-
-/**
- * Checks if the given DOM node is a ShadowRoot.
- */
-declare function isShadowRoot(node: Node): node is ShadowRoot;
-export { isShadowRoot }
-export { isShadowRoot as isShadowRoot_alias_1 }
-
-/**
- * Checks if the given DOM node is an SVGElement.
- */
-declare function isSVGElement(node: Node): node is SVGElement;
-export { isSVGElement }
-export { isSVGElement as isSVGElement_alias_1 }
-
-/**
- * Checks if the given DOM node is a Text node.
- */
-declare function isTextNode(node: Node): node is Text;
-export { isTextNode }
-export { isTextNode as isTextNode_alias_1 }
-
-/**
- * Checks if the given value is likely a Window object.
- */
-declare function isWindowLike(value: unknown): value is Window;
-export { isWindowLike }
-export { isWindowLike as isWindowLike_alias_1 }
-
-export { }