vuejs / vuejs/docs

Complete documentation on app.config.errorHandler

Open
#2,070 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Vue
Stars
3.2k
Forks
5k
Avg merge
14d 17h
Merged PRs (30d)
1

Description

What problem does this feature solve?

Ref : https://vuejs.org/api/application.html#app-config-errorhandler .

I recently introduced a bug in a plugin that implements app.config.errorHandler that would impact developers mainly during local development : errors are never displayed in the console.

situation

When I read the documentation, it was not clear to me if the errors were still reported in the console. I wrongly supposed that it was the case.
After investigation in the VujeJS source code, I understood that if an errorHandler is set, then the default handler (console.error) is not called.

Hypothesis of cause

  • the documentation does not warn about the need for the developer to call manually console.error / the default handler
  • the forward to the default handler was not easy to implement : I tried handleError(error, null, 10 as ErrorCodes /* ErrorCodes.APP_ERROR_HANDLER */, false) but I am not sure if it is the right way to do it...

Suggestion of counter mesure

I would recommend to add an example in the documentation to forward error handling to the default VueJS handler.

What does the proposed API look like?

N/A

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the app.config.errorHandler section at the linked application API documentation page and review how nearby examples describe error handling. Clarify that supplying an errorHandler replaces the default console reporting, and add the requested example or warning showing how developers can forward errors; the documentation should make the behavior unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.