Skip to content

Commit 6fced65

Browse files
committed
docs(docusaurus): add @ng-catbee and restructure @catbee/utils docs
1 parent c90bf15 commit 6fced65

49 files changed

Lines changed: 2125 additions & 982 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License
22

3-
Copyright (c) 2025 Catbee Technologies. https://catbee-utils.npm.hprasath.com/license
3+
Copyright (c) 2025 Catbee Technologies. https://catbee.npm.hprasath.com/license
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/docs/@catbee/@catbee.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: catbee
3+
sidebar_position: 1
4+
---
5+
6+
# @catbee
7+
8+
> A collection of **lightweight, powerful, and modular backend utilities** for modern **Node.js** and **TypeScript** applications — developed and maintained by **Catbee Technologies**.
9+
10+
---
11+
12+
## 🚀 Overview
13+
14+
`@catbee` offers a suite of **general-purpose libraries** crafted for developers who value:
15+
16+
-**Performance-focused utilities**
17+
- 🧠 **Type-safe abstractions**
18+
- 🧩 **Composable APIs**
19+
- 🧰 **Production-ready helpers** for everyday backend development
20+
21+
Each module is designed to be:
22+
- 🪶 **Lightweight**
23+
- 📘 **Fully documented**
24+
- 🧩 **Framework-agnostic**
25+
- ⚙️ **Optimized for both ESM and CJS**
26+
27+
---
28+
29+
## 📦 Available Packages
30+
31+
| Package | Description | Documentation |
32+
|----------|--------------|----------------|
33+
| [`@catbee/utils`](./utils/intro) | A collection of reusable TypeScript utilities for async, array, string, cache, process, and more. | [View Docs →](./utils/intro) |
34+
35+
---
File renamed without changes.
File renamed without changes.
Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
---
2+
slug: /@catbee/utils/intro
23
sidebar_position: 1
3-
slug: /
4+
45
---
56

67
# Introduction
78

8-
## 🧰 @catbee/utils – The Ultimate Utility Toolkit for Node.js & TypeScript
9+
## @catbee/utils – The Ultimate Utility Toolkit for Node.js & TypeScript
910

1011
A modular, production-grade utility library for Node.js and TypeScript, built for robust, scalable applications and enterprise Express services. Every utility is tree-shakable, fully typed, and can be imported independently for optimal bundle size.
1112

1213
<div style={{ display: 'flex', flexWrap: 'wrap', gap: '0.5rem', margin: '1rem 0', }}>
1314
<img src="https://img.shields.io/badge/build-passing-brightgreen" alt="Build Status" />
14-
<img src="https://codecov.io/gh/catbee-technologies/catbee-utils/graph/badge.svg?token=XAJHK6R1OQ" alt="Coverage" />
15+
<img src="https://codecov.io/gh/catbee-technologies/catbee-modules/graph/badge.svg?token=XAJHK6R1OQ" alt="Coverage" />
1516
<img src="https://img.shields.io/node/v/@catbee/utils" alt="Node Version" />
1617
<img src="https://img.shields.io/npm/v/@catbee/utils" alt="NPM Version" />
17-
<!-- <img src="https://img.shields.io/npm/v/@catbee/utils/rc" alt="NPM RC Version" />
18-
<img src="https://img.shields.io/npm/v/@catbee/utils/next" alt="NPM Next Version" /> -->
18+
<!-- <img src="https://img.shields.io/npm/v/@catbee/modules/rc" alt="NPM RC Version" />
19+
<img src="https://img.shields.io/npm/v/@catbee/modules/next" alt="NPM Next Version" /> -->
1920
<img src="https://img.shields.io/npm/dt/@catbee/utils" alt="NPM Downloads" />
2021
<img src="https://img.shields.io/npm/types/@catbee/utils" alt="TypeScript Types" />
2122
<!-- <img src="https://img.shields.io/librariesio/release/npm/@catbee%2Futils" alt="Dependencies" /> -->
2223
<img src="https://img.shields.io/maintenance/yes/2025" alt="Maintenance" />
23-
<img src="https://snyk.io/test/github/catbee-technologies/catbee-utils/badge.svg" alt="Snyk Vulnerabilities" />
24+
<img src="https://snyk.io/test/github/catbee-technologies/catbee-modules/badge.svg" alt="Snyk Vulnerabilities" />
2425
<img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=alert_status&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Quality Gate Status" />
2526
<img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=ncloc&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Lines of Code" />
2627
<img src="https://sonarcloud.io/api/project_badges/measure?project=catbee-technologies_catbee-utils&metric=security_rating&token=93da835f2d48d37b41fa628cc7fc764c873bd700" alt="Security Rating" />
@@ -104,33 +105,33 @@ Enterprise-grade Express server utilities:
104105

105106
Explore the full suite of utilities, each with detailed API docs and examples:
106107

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

132133
---
133134

134135
## 📜 License
135136

136-
MIT © catbee-technologies
137+
MIT © Catbee Technologies (see the [LICENSE](/license/) file for the full text)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)