Network Pipe Manufacturer

    modern-errors-bugs
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.0 • Public • Published
    modern-errors logo

    Node Browsers TypeScript Codecov Minified size Twitter Medium

    modern-errors plugin to print where to report bugs.

    This appends a bug reports URL to error messages.

    Example

    Adding the plugin to modern-errors.

    import ModernError from 'modern-errors'
    import modernErrorsBugs from 'modern-errors-bugs'
    
    export const BaseError = ModernError.subclass('BaseError', {
      plugins: [modernErrorsBugs],
    })

    Configuring the bugs report URL.

    export const UnknownError = BaseError.subclass('UnknownError', {
      bugs: 'https://github.com/my-name/my-project/issues',
    })

    Unknown errors now include the following message.

    Please report this bug at: https://github.com/my-name/my-project/issues
    

    Install

    npm install modern-errors-bugs

    This package works in both Node.js >=14.18.0 and browsers. It is an ES module and must be loaded using an import or import() statement, not require().

    API

    modernErrorsBugs

    Type: Plugin

    Plugin object to pass to the plugins option of ErrorClass.subclass().

    Configuration

    The bug reports URL must be a string or a URL.

    While this plugin is especially useful with unknown errors, it can also apply to (in priority order):

    export const BaseError = ModernError.subclass('BaseError', {
      plugins: [modernErrorsBugs],
      bugs: 'https://github.com/my-name/my-project/issues',
    })
    export const UnknownError = BaseError.subclass('UnknownError', {
      bugs: 'https://github.com/my-name/my-project/issues',
    })
    throw new ExampleError('...', {
      bugs: 'https://github.com/my-name/my-project/issues',
    })

    Related projects

    Support

    For any question, don't hesitate to submit an issue on GitHub.

    Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.

    Contributing

    This project was made with ❤️. The simplest way to give back is by starring and sharing it online.

    If the documentation is unclear or has a typo, please click on the page's Edit button (pencil icon) and suggest a correction.

    If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!

    Install

    npm i modern-errors-bugs

    DownloadsWeekly Downloads

    121

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    10.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • ehmicky