@ntnyq/utils 0.0.2 → 0.0.3

package/README.md

@@ -14,6 +14,8 @@ pnpm add @ntnyq/utils -D
 - [capitalize](./src/capitalize.ts)
 - [kekabCase](./src/kekabCase.ts)
 
+- [waitFor](./src/waitFor.ts)
+
 ## License
 
 [MIT](./LICENSE) License © 2022-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.cjs

@@ -12,6 +12,40 @@ function capitalize(input) {
   return `${input.charAt(0).toUpperCase()}${input.slice(1)}`;
 }
 
+function waitFor(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+function toArray(val) {
+  val = val ?? [];
+  return Array.isArray(val) ? val : [val];
+}
+
+const isBrowser = () => typeof document !== "undefined";
+
+const root = isBrowser() ? window : global;
+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;
+}
+function rAF(fn) {
+  const raf = root.requestAnimationFrame || mockRAF;
+  return raf.call(root, fn);
+}
+function cAF(id) {
+  const caf = root.cancelAnimationFrame || root.clearTimeout;
+  return caf.call(root, id);
+}
+
+exports.cAF = cAF;
 exports.camelCase = camelCase;
 exports.capitalize = capitalize;
+exports.isBrowser = isBrowser;
 exports.kekabCase = kekabCase;
+exports.rAF = rAF;
+exports.toArray = toArray;
+exports.waitFor = waitFor;

package/dist/index.d.cts

@@ -0,0 +1,90 @@
+import { Nullable, Arrayable } from '@ntnyq/types';
+
+/**
+ * transform given string to kekabCase
+ *
+ * @param input given string
+ * @returns string in kekabCase
+ *
+ * @example
+ * ```
+ * import { kekabCase } from '@ntnyq/utils'
+ * kekabCase('FooBarBaz') // foo-bar-baz
+ * ```
+ */
+declare function kekabCase(input: string): string;
+
+/**
+ * transform given string to camelCase
+ *
+ * @param input given string
+ * @returns string in camelCase
+ *
+ * @example
+ * ```
+ * import { camelCase } from '@ntnyq/utils'
+ * camelCase('foo-bar-baz') // fooBarBaz
+ * ```
+ */
+declare function camelCase(input: string): string;
+
+/**
+ * capitalize the given string's first letter
+ *
+ * @param input given string
+ * @returns string first letter capitalize
+ *
+ * @example
+ * ```
+ * import { capitalize } from '@ntnyq/utils'
+ * capitalize('fooBarBaz') // FooBarBaz
+ * ```
+ */
+declare function capitalize(input: string): string;
+
+/**
+ * Wait for a number of milliseconds
+ *
+ * @param ms millseconds to wait
+ * @returns a promise that resolves after ms milliseconds
+ *
+ * @example
+ * ```
+ * import { waitFor } from '@ntnyq/utils'
+ * await waitFor(3e3)
+ * // do somthing after 3 seconds
+ * ```
+ */
+declare function waitFor(ms: number): Promise<unknown>;
+
+declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+
+/**
+ * @file env.ts
+ */
+/**
+ * Checks if the code is running in a browser
+ *
+ * @returns boolean - true if the code is running in a browser
+ */
+declare const isBrowser: () => boolean;
+
+/**
+ * @file raf.ts
+ */
+/**
+ * Request animation frame
+ *
+ * @param fn callback
+ * @returns id
+ */
+declare function rAF(fn: FrameRequestCallback): number;
+/**
+ * Cancel animation frame
+ *
+ * @param id id
+ * @returns void
+ */
+declare function cAF(id: number): void;
+
+export { cAF, camelCase, capitalize, isBrowser, kekabCase, rAF, toArray, waitFor };

package/dist/index.d.mts

@@ -0,0 +1,90 @@
+import { Nullable, Arrayable } from '@ntnyq/types';
+
+/**
+ * transform given string to kekabCase
+ *
+ * @param input given string
+ * @returns string in kekabCase
+ *
+ * @example
+ * ```
+ * import { kekabCase } from '@ntnyq/utils'
+ * kekabCase('FooBarBaz') // foo-bar-baz
+ * ```
+ */
+declare function kekabCase(input: string): string;
+
+/**
+ * transform given string to camelCase
+ *
+ * @param input given string
+ * @returns string in camelCase
+ *
+ * @example
+ * ```
+ * import { camelCase } from '@ntnyq/utils'
+ * camelCase('foo-bar-baz') // fooBarBaz
+ * ```
+ */
+declare function camelCase(input: string): string;
+
+/**
+ * capitalize the given string's first letter
+ *
+ * @param input given string
+ * @returns string first letter capitalize
+ *
+ * @example
+ * ```
+ * import { capitalize } from '@ntnyq/utils'
+ * capitalize('fooBarBaz') // FooBarBaz
+ * ```
+ */
+declare function capitalize(input: string): string;
+
+/**
+ * Wait for a number of milliseconds
+ *
+ * @param ms millseconds to wait
+ * @returns a promise that resolves after ms milliseconds
+ *
+ * @example
+ * ```
+ * import { waitFor } from '@ntnyq/utils'
+ * await waitFor(3e3)
+ * // do somthing after 3 seconds
+ * ```
+ */
+declare function waitFor(ms: number): Promise<unknown>;
+
+declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+
+/**
+ * @file env.ts
+ */
+/**
+ * Checks if the code is running in a browser
+ *
+ * @returns boolean - true if the code is running in a browser
+ */
+declare const isBrowser: () => boolean;
+
+/**
+ * @file raf.ts
+ */
+/**
+ * Request animation frame
+ *
+ * @param fn callback
+ * @returns id
+ */
+declare function rAF(fn: FrameRequestCallback): number;
+/**
+ * Cancel animation frame
+ *
+ * @param id id
+ * @returns void
+ */
+declare function cAF(id: number): void;
+
+export { cAF, camelCase, capitalize, isBrowser, kekabCase, rAF, toArray, waitFor };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Nullable, Arrayable } from '@ntnyq/types';
+
 /**
  * transform given string to kekabCase
  *
@@ -40,4 +42,49 @@ declare function camelCase(input: string): string;
  */
 declare function capitalize(input: string): string;
 
-export { camelCase, capitalize, kekabCase };
+/**
+ * Wait for a number of milliseconds
+ *
+ * @param ms millseconds to wait
+ * @returns a promise that resolves after ms milliseconds
+ *
+ * @example
+ * ```
+ * import { waitFor } from '@ntnyq/utils'
+ * await waitFor(3e3)
+ * // do somthing after 3 seconds
+ * ```
+ */
+declare function waitFor(ms: number): Promise<unknown>;
+
+declare function toArray<T>(val?: Nullable<Arrayable<T>>): Arrayable<T>;
+
+/**
+ * @file env.ts
+ */
+/**
+ * Checks if the code is running in a browser
+ *
+ * @returns boolean - true if the code is running in a browser
+ */
+declare const isBrowser: () => boolean;
+
+/**
+ * @file raf.ts
+ */
+/**
+ * Request animation frame
+ *
+ * @param fn callback
+ * @returns id
+ */
+declare function rAF(fn: FrameRequestCallback): number;
+/**
+ * Cancel animation frame
+ *
+ * @param id id
+ * @returns void
+ */
+declare function cAF(id: number): void;
+
+export { cAF, camelCase, capitalize, isBrowser, kekabCase, rAF, toArray, waitFor };

package/dist/index.mjs

@@ -10,4 +10,33 @@ function capitalize(input) {
   return `${input.charAt(0).toUpperCase()}${input.slice(1)}`;
 }
 
-export { camelCase, capitalize, kekabCase };
+function waitFor(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+function toArray(val) {
+  val = val ?? [];
+  return Array.isArray(val) ? val : [val];
+}
+
+const isBrowser = () => typeof document !== "undefined";
+
+const root = isBrowser() ? window : global;
+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;
+}
+function rAF(fn) {
+  const raf = root.requestAnimationFrame || mockRAF;
+  return raf.call(root, fn);
+}
+function cAF(id) {
+  const caf = root.cancelAnimationFrame || root.clearTimeout;
+  return caf.call(root, id);
+}
+
+export { cAF, camelCase, capitalize, isBrowser, kekabCase, rAF, toArray, waitFor };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ntnyq/utils",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "publishConfig": {
     "access": "public"
   },
@@ -18,12 +18,17 @@
     "directory": "packages/utils"
   },
   "exports": {
+    "./package.json": "./package.json",
     ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.cjs",
-      "import": "./dist/index.mjs"
-    },
-    "./*": "./*"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -43,6 +48,9 @@
   "bugs": {
     "url": "https://github.com/ntnyq/ntnyq-utils/issues"
   },
+  "dependencies": {
+    "@ntnyq/types": "0.0.2"
+  },
   "scripts": {
     "build": "unbuild",
     "dev": "unbuild --stub"