@supuwoerc/toolkit

A collection of utility functions for JavaScript/TypeScript.

Features

• TypeScript support: Fully typed with generics.
• Tested: Comprehensive test suite with Vitest.
• Documented: Auto-generated API documentation via TypeDoc.

Installation

npm install @supuwoerc/toolkit
Copy

or using pnpm:

pnpm add @supuwoerc/toolkit
Copy

or using yarn:

yarn add @supuwoerc/toolkit
Copy

Usage

ES Modules / TypeScript

import { array2Tree, pick, shuffle, sleep, tree2Array, withTimeout } from '@supuwoerc/toolkit'

// Convert flat array to tree
const flat = [
  { id: 1, parentId: null },
  { id: 2, parentId: 1 },
  { id: 3, parentId: 1 },
]
const tree = array2Tree(flat, { idKey: 'id', parentKey: 'parentId' })
console.log(tree)

// Shuffle an array
const arr = [1, 2, 3, 4, 5]
const shuffled = shuffle(arr)
console.log(shuffled)

// Pick properties from an object
const obj = { a: 1, b: 2, c: 3 }
const picked = pick(obj, ['a', 'c']) // { a: 1, c: 3 }

// Sleep for 1 second
await sleep(1000)

// Timeout a promise
try {
  const result = await withTimeout(fetch('https://example.com'), 5000)
} catch (err) {
  console.log('Timeout or error', err)
}
Copy

CommonJS

const { shuffle } = require('@supuwoerc/toolkit')
Copy

API Documentation

Full API documentation is available at https://supuwoerc.github.io/toolkit/.

You can also generate documentation locally:

pnpm run doc
Copy

Then open docs/index.html in your browser.

Development

Prerequisites

• Node.js >= 18
• pnpm (recommended) or npm

Setup

git clone https://github.com/supuwoerc/toolkit.git
pnpm install
Copy

Build

pnpm run build
Copy

Test

pnpm test           # run tests once
pnpm test:watch     # run tests in watch mode
pnpm test:ui        # open Vitest UI
pnpm test:coverage  # generate coverage report
Copy

Lint

pnpm run lint
Copy

Release

Releases are automated via release-it. To create a new release:

pnpm run release
Copy

This will run tests, build, update changelog, tag, and publish to npm.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Add tests for your changes.
5. Ensure linting passes.
6. Submit a pull request.

License

MIT © Idris. See LICENSE for details.