Skip to content

errors.ts: Add JSDoc for all exported error classes #686

Description

@Kingsman-99

Description

src/errors.ts defines the SDK's error class hierarchy but none of the classes have JSDoc explaining when they are thrown, what their fields mean, or how callers should handle them. This makes error handling documentation-poor for SDK consumers.

Acceptance Criteria

  • Every exported error class has a JSDoc comment explaining when it is thrown
  • Constructor parameters and public fields have inline /** */ comments
  • At least one @example showing how to catch and inspect each error class
  • Unit tests pass

Context

  • Target file: src/errors.ts
  • Documentation only; do not change class structure or inheritance

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions