Skip to content

fix: update README to reflect actual API#14

Merged
codewizdave merged 1 commit into
mainfrom
fix/readme-accurate-api
Jun 3, 2026
Merged

fix: update README to reflect actual API#14
codewizdave merged 1 commit into
mainfrom
fix/readme-accurate-api

Conversation

@martyy-code

Copy link
Copy Markdown
Contributor

Summary

  • Fix README to use actual library API instead of non-existent exports
  • Replaced errorOf, errorWithCause, BaseError, ErrorKind with error factory, .from() method, is, and causes
  • Added examples for all features: error creation, exception chaining, hierarchical inheritance, type checking, and cause traversal

Test plan

  • Review code examples match actual exports in src/index.ts
  • Verify message template interpolation works as documented
  • Confirm .from() chaining example is accurate
  • Test examples locally

README was using non-existent exports (errorOf, errorWithCause,
BaseError, ErrorKind) instead of the actual API (error factory,
.from() method, is, causes).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
errors-web Ready Ready Preview, Comment Jun 3, 2026 9:37am

@codewizdave codewizdave merged commit 598e8e7 into main Jun 3, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants