📑 Table of Contents

• Description
• Key Features
• Use Cases
• Tech Stack
• Quick Start
• Available Scripts
• Project Structure
• Contributors
• Contributing
• License

📝 Description

@myko.pk/errors provides structured error classes and typed error codes for the MYKO ecosystem. Every MYKO package — from database adapters to HTTP services — throws errors from this library, ensuring consistent error shape, serialization, and HTTP status code mapping across the entire stack. Includes DatabaseError and RedisError classes with structured context, typed error code enums, and automatic status code inference.

✨ Key Features

• 🧱 Structured Error Classes — DatabaseError and RedisError with code, statusCode, cause, and context fields.
• 🔢 Typed Error Codes — DATABASE_ERROR_CODES and REDIS_ERROR_CODES enums for type-safe error handling.
• 🌐 HTTP Status Mapping — Every error code maps to an appropriate HTTP status code automatically.
• 📦 JSON Serializable — toJSON() for clean API responses.
• 📘 Fully Typed — Full TypeScript support with exported code type utilities.

🎯 Use Cases

• Throwing consistent DatabaseError instances from every database adapter (Drizzle, Prisma, SQL, Supabase) with a shared error code vocabulary.
• Mapping internal error codes to HTTP status codes for REST API responses.
• Structured error logging with cause and context for debugging distributed systems.

🛠️ Tech Stack

• 📘 TypeScript

Notable libraries: None — pure error classes, zero runtime deps.

⚡ Quick Start

npm install @myko.pk/errors

import { DatabaseError, DATABASE_ERROR_CODES } from '@myko.pk/errors';
import { REDIS_ERROR_CODES } from '@myko.pk/errors/codes';

throw new DatabaseError(DATABASE_ERROR_CODES.CONNECT_FAILED, {
  cause: originalError,
  context: { host: 'db-primary' },
});
// JSON serialization: { code: 'db.connect_failed', statusCode: 503, ... }

🚀 Available Scripts

• build — npm run build
• typecheck — npm run typecheck

📁 Project Structure

.
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── SECURITY.md
├── package.json
├── src
│   ├── codes
│   │   └── index.ts
│   ├── errors
│   │   ├── DatabaseError.ts
│   │   ├── RedisError.ts
│   │   └── index.ts
│   └── index.ts
├── tsconfig.json
└── tsup.config.mjs

🛠️ Development Setup

1. Install Node.js (v18+ recommended)
2. Install dependencies: npm install
3. Build: npm run build

🧪 Testing

This project currently exports error classes — runtime tests can be added via Vitest.

npm run test

👥 Contributors

See the full list of contributors →

👥 Contributing

Contributions are welcome! Here's the standard flow:

1. Fork the repository
2. Clone your fork: git clone https://github.com/mykopk/errors.git
3. Branch: git checkout -b feature/your-feature
4. Commit: git commit -m 'feat: add some feature'
5. Push: git push origin feature/your-feature
6. Open a pull request

Please follow the existing code style and include tests for new behavior where applicable.

📜 License

This project is licensed under the MIT License.

Company

MYKO Pakistan

Detail Information Website myko.pk Email [email protected] About Building digital infrastructure and super-app experiences for millions of users across Pakistan. Built with ❤️ in Pakistan 🇵🇰