Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 96 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ A TypeScript error handling library with exception chaining, hierarchical inheri

## Features

- **Exception Chaining** — Preserve the full context of errors with cause chains
- **Hierarchical Inheritance** — Organize errors in meaningful hierarchies
- **Rich Error Semantics** — Attach metadata, codes, and structured data to errors
- **Exception Chaining** — Preserve the full context of errors with cause chains via `.from()`
- **Hierarchical Inheritance** — Organize errors in meaningful hierarchies with single or multiple inheritance
- **Rich Error Semantics** — Attach structured data, templates, and notes to errors
- **TypeScript First** — Full type safety with comprehensive type definitions

## Installation
Expand All @@ -21,25 +21,100 @@ yarn add @deessejs/errors

## Quick Start

### Creating Errors

```typescript
import { error } from '@deessejs/errors';

// Simple error
const ValidationError = error({ name: 'ValidationError' });
const err = ValidationError();

// Error with message template
const ValidationError = error({
name: 'ValidationError',
message: 'Field "{field}" is invalid: {reason}',
});

const err = ValidationError({ field: 'email', reason: 'invalid format' });
// err.message === 'Field "email" is invalid: invalid format'
```

### Exception Chaining

```typescript
import { error } from '@deessejs/errors';

const ValidationError = error({ name: 'ValidationError' });
const ProcessingError = error({ name: 'ProcessingError' });

const validationErr = ValidationError({ field: 'email' });
const processingErr = ProcessingError();

// Chain errors with .from()
processingErr.from(validationErr);

console.log(processingErr.message); // "ProcessingError"
console.log(processingErr.cause); // validationErr
console.log(processingErr.causes); // [validationErr]
```

### Hierarchical Inheritance

```typescript
import { BaseError, ErrorKind, errorOf, errorWithCause } from '@deessejs/errors';

// Create typed errors
const myError = errorOf(
'VALIDATION_ERROR',
'Invalid input provided',
{ field: 'email', value: 'not-an-email' }
);

// Chain errors with context
const wrapped = errorWithCause(
errorOf('PROCESSING_ERROR', 'Failed to process data'),
myError
);

// Access the full chain
console.log(wrapped.message); // "Failed to process data"
console.log(wrapped.cause?.message); // "Invalid input provided"
import { error } from '@deessejs/errors';

// Single inheritance
const AppError = error({ name: 'AppError' });
const ValidationError = error({
name: 'ValidationError',
inherits: AppError,
});

// Multiple inheritance
const NetworkError = error({ name: 'NetworkError' });
const StorageError = error({ name: 'StorageError' });
const CombinedError = error({
name: 'CombinedError',
inherits: [NetworkError, StorageError],
});
```

### Type Checking

```typescript
import { error, is } from '@deessejs/errors';

const AppError = error({ name: 'AppError' });
const ValidationError = error({
name: 'ValidationError',
inherits: AppError,
});

const err = ValidationError();

is(err, ValidationError); // true
is(err, AppError); // true (inherits from AppError)
```

### Traverse Cause Chain

```typescript
import { error, causes } from '@deessejs/errors';

const Err1 = error({ name: 'Err1' });
const Err2 = error({ name: 'Err2' });
const Err3 = error({ name: 'Err3' });

const err1 = Err1();
const err2 = Err2().from(err1);
const err3 = Err3().from(err2);

// Iterate through the cause chain
for (const cause of causes(err3)) {
console.log(cause.name);
}
// Output: Err2, Err1
```

## Documentation
Expand Down
Loading