feat: add functions.

README.md

@@ -15,12 +15,9 @@ Some util functions.
 
 [npm-version-src]: https://img.shields.io/npm/v/@gui117/util
 [npm-version-href]: https://npmjs.com/package/@gui117/util
-
 [npm-downloads-src]: https://img.shields.io/npm/dm/@gui117/util
 [npm-downloads-href]: https://npmjs.com/package/@gui117/util
-
 [bundle-src]: https://img.shields.io/bundlephobia/minzip/@gui117/util
 [bundle-href]: https://bundlephobia.com/result?p=@gui117/util
-
 [license-src]: https://img.shields.io/github/license/gui117/util.svg
 [license-href]: https://github.com/gui117/@gui117/util/blob/main/LICENSE

eslint.config.mjs

@@ -0,0 +1,5 @@
+import config from '@antfu/eslint-config'
+
+export default config({
+ formatters: true,
+})

package.json

@@ -5,12 +5,12 @@
  "packageManager": "[email protected]",
  "description": "Some util functions.",
  "license": "MIT",
- "homepage": "https://github.com/gui117/@gui117/util#readme",
+ "homepage": "https://github.com/gui117/util#readme",
  "repository": {
  "type": "git",
- "url": "git+https://github.com/gui117/@gui117/util.git"
+ "url": "git+https://github.com/gui117/util.git"
  },
- "bugs": "https://github.com/gui117/@gui117/util/issues",
+ "bugs": "https://github.com/gui117/util/issues",
  "keywords": [],
  "sideEffects": false,
  "exports": {
@@ -52,6 +52,7 @@
  "@types/node": "^22.5.0",
  "bumpp": "^9.5.2",
  "eslint": "^9.9.0",
+ "eslint-plugin-format": "^0.1.2",
  "esno": "^4.7.0",
  "lint-staged": "^15.2.9",
  "simple-git-hooks": "^2.11.1",

src/array/index.test.ts

@@ -0,0 +1,8 @@
+import { describe, expect, it } from 'vitest'
+import { chunkArray } from '.'
+
+describe('array', () => {
+ it('chunkArray', () => {
+ expect(chunkArray([1, 2, 3, 4, 5, 6, 7], 3)).toEqual([[1, 2, 3], [4, 5, 6], [7]])
+ })
+})

src/array/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Split an array into chunks
+ * @param arr Array to split
+ * @param size Number of elements in each chunk
+ * @returns Array of chunks
+ *
+ * @example
+ * ```ts
+ * chunkArray([1, 2, 3, 4, 5, 6, 7], 3) // [[1, 2, 3], [4, 5, 6], [7]]
+ * ```
+ */
+export function chunkArray(arr: unknown[], size: number) {
+ return Array.from(
+ { length: Math.ceil(arr.length / size) },
+ (v, i) => arr.slice(i * size, i * size + size),
+ )
+}

src/event/index.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, it, vi } from 'vitest'
+import { debounce, sleep, throttle } from '.'
+
+describe('event', () => {
+ it('sleep', async () => {
+ const fn = vi.fn()
+ fn()
+ sleep(100).then(fn)
+ expect(fn).toBeCalledTimes(1)
+ setTimeout(() => {
+ expect(fn).toBeCalledTimes(2)
+ }, 200)
+ })
+
+ it('throttle', () => {
+ const fn = vi.fn()
+ const throttledFn = throttle(fn, 1000)
+ throttledFn(1)
+ throttledFn(2)
+ expect(fn).toBeCalledTimes(1)
+ })
+
+ it('debounce', () => {
+ const fn = vi.fn()
+ const debouncedFn = debounce(fn, 1000)
+ debouncedFn(1)
+ debouncedFn(2)
+ debouncedFn(3)
+ expect(fn).toBeCalledTimes(0)
+ })
+})

src/event/index.ts

@@ -0,0 +1,66 @@
+/**
+ * Sleep function
+ * @param ms Milliseconds to sleep
+ * @returns Promise
+ *
+ * @example
+ * ```ts
+ * await sleep(1000)
+ * ```
+ */
+export function sleep(ms: number) {
+ return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+/**
+ * Debounce function
+ * @param fn Function to debounce
+ * @param delay Delay in milliseconds
+ * @returns Debounced function
+ *
+ * @example
+ * ```ts
+ * const debouncedFn = debounce((str) => {
+ * console.log(str)
+ * }, 1000)
+ * debouncedFn('Hello')
+ * ```
+ */
+export function debounce(fn: (...args: any[]) => void, delay: number) {
+ let timeoutId: ReturnType<typeof setTimeout> | null = null
+ return function (...args: any[]) {
+ if (timeoutId)
+ clearTimeout(timeoutId)
+
+ timeoutId = setTimeout(() => {
+ fn(...args)
+ timeoutId = null
+ }, delay)
+ }
+}
+
+/**
+ * Throttle function
+ * @param fn Function to throttle
+ * @param delay Delay in milliseconds
+ * @returns Throttled function
+ *
+ * @example
+ * ```ts
+ * const throttledFn = throttle((str) => {
+ * console.log(str)
+ * }, 1000)
+ * throttledFn('Hello')
+ * ```
+ */
+export function throttle(fn: (...args: any[]) => void, delay: number) {
+ let timeoutId: ReturnType<typeof setTimeout> | null = null
+ return function (...args: any[]) {
+ if (!timeoutId) {
+ fn(...args)
+ timeoutId = setTimeout(() => {
+ timeoutId = null
+ }, delay)
+ }
+ }
+}

src/index.ts

@@ -1,2 +1,7 @@
-export const one = 1
-export const two = 2
+export * from './math'
+export * from './string'
+export * from './url'
+export * from './array'
+export * from './event'
+export * from './match'
+export * from './object'