Skip to content

Commit dbd2a3b

Browse files
cyber-haribavi-r
cyber-hari
authored and
bavi-r
committed
docs: update README
1 parent 693f83c commit dbd2a3b

1 file changed

Lines changed: 50 additions & 36 deletions

File tree

‎README.md‎

Lines changed: 50 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# @catbee/utils
22

3-
<!-- <div style="width: 100%; display: flex; align-items: center; justify-content: space-between;">
4-
<b style="font-size: 24px; text-decoration: none;">@catbee/utils</b>
5-
<a href="https://sonarcloud.io/summary/new_code?id=catbee-technologies_catbee-utils">
6-
<img src="https://sonarcloud.io/images/project_badges/sonarcloud-dark.svg" alt="SonarQube Cloud" width="200"/>
7-
</a>
8-
</div> -->
93

104
## 🧰 Utility Modules for Node.js
115

@@ -20,7 +14,7 @@ A modular, production-grade utility toolkit for Node.js and TypeScript, designed
2014
<img src="https://img.shields.io/npm/v/@catbee/utils/next" alt="NPM Next Version" /> -->
2115
<img src="https://img.shields.io/npm/dt/@catbee/utils" alt="NPM Downloads" />
2216
<img src="https://img.shields.io/npm/types/@catbee/utils" alt="TypeScript Types" />
23-
<img src="https://img.shields.io/maintenance/yes/2025" alt="Maintenance" />
17+
<img src="https://img.shields.io/maintenance/yes/2050" alt="Maintenance" />
2418
<img src="https://snyk.io/test/github/catbee-technologies/catbee-utils/badge.svg" alt="Snyk Vulnerabilities" />
2519
<img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=alert_status&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Quality Gate Status" />
2620
<img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=ncloc&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Lines of Code" />
@@ -111,44 +105,64 @@ server.enableGracefulShutdown();
111105

112106
## 📚 Modules Overview
113107

114-
| Module | Description |
115-
| ------ | ----------- |
116-
| [Express Server](https://catbee.in/docs/@catbee/utils/express-server) | Fast, secure, and scalable server setup |
117-
| [Array Utilities](https://catbee.in/docs/@catbee/utils/modules/array) | Advanced array manipulation |
118-
| [Async Utilities](https://catbee.in/docs/@catbee/utils/modules/async) | Promise helpers, concurrency, timing |
119-
| [Cache Utilities](https://catbee.in/docs/@catbee/utils/modules/cache) | In-memory caching with TTL |
120-
| [Context Store](https://catbee.in/docs/@catbee/utils/modules/context-store) | Per-request context via AsyncLocalStorage |
121-
| [Crypto Utilities](https://catbee.in/docs/@catbee/utils/modules/crypto) | Hashing, encryption, tokens |
122-
| [Date Utilities](https://catbee.in/docs/@catbee/utils/modules/date) | Date/time manipulation |
123-
| [Decorators Utilities](https://catbee.in/docs/@catbee/utils/modules/decorators) | TypeScript decorators for Express |
124-
| [Directory Utilities](https://catbee.in/docs/@catbee/utils/modules/directory) | Directory and file system helpers |
125-
| [Environment Utilities](https://catbee.in/docs/@catbee/utils/modules/environment) | Env variable management |
126-
| [Exception Utilities](https://catbee.in/docs/@catbee/utils/modules/exception) | HTTP and error handling |
127-
| [File System Utilities](https://catbee.in/docs/@catbee/utils/modules/file-system) | File operations |
128-
| [HTTP Status Codes](https://catbee.in/docs/@catbee/utils/modules/http-status-codes) | Typed status codes |
129-
| [ID Utilities](https://catbee.in/docs/@catbee/utils/modules/id) | UUID and ID generation |
130-
| [Logger Utilities](https://catbee.in/docs/@catbee/utils/modules/logger) | Structured logging with Pino |
131-
| [Middleware Utilities](https://catbee.in/docs/@catbee/utils/modules/middleware) | Express middleware collection |
132-
| [Object Utilities](https://catbee.in/docs/@catbee/utils/modules/object) | Deep merge, flatten, pick/omit, etc. |
133-
| [Performance Utilities](https://catbee.in/docs/@catbee/utils/modules/performance) | Timing, memoization, memory tracking |
134-
| [Request Utilities](https://catbee.in/docs/@catbee/utils/modules/request) | HTTP request parameter parsing/validation |
135-
| [Response Utilities](https://catbee.in/docs/@catbee/utils/modules/response) | Standardized API response formatting |
136-
| [Stream Utilities](https://catbee.in/docs/@catbee/utils/modules/stream) | Stream conversion, batching, throttling, line splitting |
137-
| [String Utilities](https://catbee.in/docs/@catbee/utils/modules/string) | Casing, masking, slugifying, formatting |
138-
| [Type Utilities](https://catbee.in/docs/@catbee/utils/modules/type) | Type checking, conversion, guards |
139-
| [URL Utilities](https://catbee.in/docs/@catbee/utils/modules/url) | URL parsing, query manipulation, normalization |
140-
| [Validate Utilities](https://catbee.in/docs/@catbee/utils/modules/validation) | Input validation functions |
108+
| Module | Description |
109+
| --------------------------------------------------------------------------- | ------------------------------------------------------- |
110+
| [Express Server](https://catbee.in/docs/@catbee/utils/server) | Fast, secure, and scalable server setup |
111+
| [Array Utilities](https://catbee.in/docs/@catbee/utils/array) | Advanced array manipulation |
112+
| [Async Utilities](https://catbee.in/docs/@catbee/utils/async) | Promise helpers, concurrency, timing |
113+
| [Cache Utilities](https://catbee.in/docs/@catbee/utils/cache) | In-memory caching with TTL |
114+
| [Context Store](https://catbee.in/docs/@catbee/utils/context-store) | Per-request context via AsyncLocalStorage |
115+
| [Crypto Utilities](https://catbee.in/docs/@catbee/utils/crypto) | Hashing, encryption, tokens |
116+
| [Date Utilities](https://catbee.in/docs/@catbee/utils/date) | Date/time manipulation |
117+
| [Decorators Utilities](https://catbee.in/docs/@catbee/utils/decorator) | TypeScript decorators for Express |
118+
| [Directory Utilities](https://catbee.in/docs/@catbee/utils/directory) | Directory and file system helpers |
119+
| [Environment Utilities](https://catbee.in/docs/@catbee/utils/environment) | Env variable management |
120+
| [Exception Utilities](https://catbee.in/docs/@catbee/utils/exception) | HTTP and error handling |
121+
| [File System Utilities](https://catbee.in/docs/@catbee/utils/fs) | File operations |
122+
| [HTTP Status Codes](https://catbee.in/docs/@catbee/utils/http-status-codes) | Typed status codes |
123+
| [ID Utilities](https://catbee.in/docs/@catbee/utils/id) | UUID and ID generation |
124+
| [Logger Utilities](https://catbee.in/docs/@catbee/utils/logger) | Structured logging with Pino |
125+
| [Middleware Utilities](https://catbee.in/docs/@catbee/utils/middleware) | Express middleware collection |
126+
| [Object Utilities](https://catbee.in/docs/@catbee/utils/object) | Deep merge, flatten, pick/omit, etc. |
127+
| [Performance Utilities](https://catbee.in/docs/@catbee/utils/performance) | Timing, memoization, memory tracking |
128+
| [Request Utilities](https://catbee.in/docs/@catbee/utils/request) | HTTP request parameter parsing/validation |
129+
| [Response Utilities](https://catbee.in/docs/@catbee/utils/response) | Standardized API response formatting |
130+
| [Stream Utilities](https://catbee.in/docs/@catbee/utils/stream) | Stream conversion, batching, throttling, line splitting |
131+
| [String Utilities](https://catbee.in/docs/@catbee/utils/string) | Casing, masking, slugifying, formatting |
132+
| [Type Utilities](https://catbee.in/docs/@catbee/utils/type) | Type checking, conversion, guards |
133+
| [Types Utilities](https://catbee.in/docs/@catbee/utils/types) | Common TypeScript types and interfaces |
134+
| [URL Utilities](https://catbee.in/docs/@catbee/utils/url) | URL parsing, query manipulation, normalization |
135+
| [Validate Utilities](https://catbee.in/docs/@catbee/utils/validation) | Input validation functions |
141136

142137
---
143138

144139
## 🏁 Usage
145140

146-
Import only what you need:
141+
This library supports flexible import patterns to suit your needs:
142+
143+
### Root-level imports (everything available)
144+
Import any utility directly from the root package:
147145

148146
```ts
149-
import { chunk, sleep, TTLCache, getLogger } from "@catbee/utils";
147+
import { chunk, sleep, TTLCache, getLogger, ServerConfigBuilder } from '@catbee/utils';
150148
```
151149

150+
### Module-level imports (scoped imports)
151+
Import only from specific modules for better organization and smaller bundles:
152+
153+
```ts
154+
// Import only server-related exports
155+
import { ServerConfigBuilder, ExpressServer } from '@catbee/utils/server';
156+
157+
// Import only date utilities
158+
import { formatDate, addDays, DateBuilder } from '@catbee/utils/date';
159+
160+
// Import only crypto utilities
161+
import { hashPassword, verifyPassword } from '@catbee/utils/crypto';
162+
```
163+
164+
Both import styles are fully supported and tree-shakable. Use whichever fits your project structure best!
165+
152166
---
153167

154168
## 📖 Documentation

0 commit comments

Comments
 (0)