@prishelets/utils
Version:
A modern utility library for strings, numbers, and general data types — fully typed, tested, and built for Node.js and TypeScript.
145 lines (97 loc) • 2.75 kB
Markdown
# @prishelets/utils
[](https://www.npmjs.com/package/@prishelets/utils)
[](https://github.com/Curslo/prishelets/actions)
[](https://github.com/Curslo/prishelets/blob/main/LICENSE)
## 📦 Description
**@prishelets/utils** is a modern, type-safe utility library for working with strings, numbers, and general data types. It’s fully typed, tested, and optimized for Node.js and TypeScript projects.
## ✨ Features
- 🧠 Fully typed with TypeScript
- 🧪 Tested with Jest
- ⚡ Lightweight and modular
- 📚 Useful for everyday string and number manipulation
- 🔧 Tree-shakable and ESM/CommonJS compatible
## 📥 Installation
```bash
npm install @prishelets/utils
# or
pnpm add @prishelets/utils
# or
yarn add @prishelets/utils
```
## 🚀 Usage
```ts
import { clamp, isEven, roundTo, randomInRange } from "@prishelets/utils";
```
```ts
clamp(5, 0, 10); // 5
isEven(4); // true
roundTo(3.14159, 2); // 3.14
randomInRange(1, 5); // e.g., 3
```
## 🔢 Number Utilities
### `clamp(value, min, max)`
Clamp a number between a min and max range.
```ts
clamp(5, 0, 10); // 5
clamp(-1, 0, 10); // 0
clamp(15, 0, 10); // 10
```
### `isEven(value)`
Check if a number is even.
```ts
isEven(4); // true
isEven(3); // false
```
### `roundTo(value, decimals)`
Round a number to a specific number of decimal places.
```ts
roundTo(3.14159, 2); // 3.14
roundTo(1.005, 2); // 1.01
```
### `randomInRange(min, max)`
Generate a random integer between `min` and `max` (inclusive).
```ts
randomInRange(1, 3); // e.g., 2
```
## 🛠 Roadmap
- [ ] String utilities
- [ ] Array helpers
- [ ] Object type guards
- [ ] Functional programming tools
- [ ] Performance benchmarks
- [ ] TypeScript documentation generator
## 📂 Project Structure
```
├── src/
│ └── numbers/
│ ├── clamp.ts
│ ├── isEven.ts
│ ├── randomInRange.ts
│ └── roundTo.ts
├── dist/ (compiled output)
├── .github/workflows/ (CI)
└── package.json
```
## 🧪 Testing
```bash
npm run test
```
This runs all tests via **Jest**. Test files are colocated with source files or kept in a `__tests__` directory.
## 🧾 License
**ISC** © [Curslo](https://github.com/Curslo)
## 💬 Feedback & Contributions
Feel free to open issues or pull requests. Ideas, bug reports, and feature requests are welcome!
🔗 GitHub: [github.com/Curslo/prishelets](https://github.com/Curslo/prishelets)