@tkeron/tools 0.2.0 โ 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +44 -2
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,3 +1,45 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @tkeron/tools
|
|
2
2
|
|
|
3
|
-
Useful
|
|
3
|
+
Useful JavaScript utilities for Bun runtime - A collection of lightweight, type-safe utilities designed specifically for the Bun environment.
|
|
4
|
+
|
|
5
|
+
## ๐ Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add @tkeron/tools
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## ๐ Requirements
|
|
12
|
+
|
|
13
|
+
- **Bun** >= 1.0.0
|
|
14
|
+
- **TypeScript** ^5.7.3
|
|
15
|
+
|
|
16
|
+
## ๐ About
|
|
17
|
+
|
|
18
|
+
This package provides a growing collection of utility functions and data structures optimized for the Bun runtime. All utilities are written in TypeScript with full type safety and are designed to be lightweight, performant, and easy to use.
|
|
19
|
+
|
|
20
|
+
## ๐ง Usage
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
// Import all utilities
|
|
24
|
+
import * as tools from '@tkeron/tools';
|
|
25
|
+
|
|
26
|
+
// Or import specific utilities
|
|
27
|
+
import { rng, getLIFO, getPaths } from '@tkeron/tools';
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## ๐ Documentation
|
|
31
|
+
|
|
32
|
+
For detailed documentation of all available utilities, please refer to the TypeScript definitions or explore the source code. Each utility is fully typed and includes JSDoc comments for better IDE support.
|
|
33
|
+
|
|
34
|
+
## ๐งช Testing
|
|
35
|
+
|
|
36
|
+
The project includes comprehensive tests for all utilities:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
bun test
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
Built with โค๏ธ for the Bun ecosystem
|