Skip to content

Create a page with error codes #378

@Ethan-Arrowood

Description

@Ethan-Arrowood

Request Type

Undocumented existing feature

What needs to be documented?

There are several different error codes that can potentially be informative:

  • In Harper, we identify and distinguish known types or classes following standard best practice of using identifiable Error constructor names. Programmatically, this available in the error.name property. In logs, this appears as ErrorInCamelCase: ... stack trace ...
    We should put together a list of known meaningful error constructor names in the page here.

  • Node.js error codes. These are available from the error.code property and are “yelled” in logs as ERR_SOME_NODE_ERROR_CODE. We can link to the list of error codes here: Errors | Node.js v25.1.0 Documentation

  • We also report errors from our endpoints using HTTP status codes. We try to follow standards for the appropriate error code (link to HTTP specs).

Where should this be documented?

No response

Why is this needed?

No response

Existing information

No response

Priority/Impact

Medium - important but not urgent

Are you planning to fix this issue?

No, just reporting the issue

First-time contributor support

  • I'm new to contributing and would appreciate guidance on the process
  • I'd like help understanding the project structure
  • I need assistance with setting up the development environment
  • I'm comfortable contributing but new to this project specifically

Metadata

Metadata

Assignees

No one assigned

    Labels

    content📝 Content specific issues and requests - text, examples, missing info, or clarityenhancement✨ New features, improvements, or suggestions to make the docs or site better

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions