Merge pull request #8490 from backstage/mob/hidden-error-docs

core-plugin-api: document ErrorApiErrorContext.hidden
2021-12-15 09:33:39 +01:00
parent 8c687e9bf5 813db5928b
commit f7fe2b3f58
1 changed files with 9 additions and 1 deletions
@@ -41,7 +41,15 @@ export type Error = ErrorApiError;
 * @public
 */
 export type ErrorApiErrorContext = {
-  // If set to true, this error should not be displayed to the user. Defaults to false.
+  /**
+   * If set to true, this error should not be displayed to the user.
+   *
+   * Hidden errors are typically not displayed in the UI, but the ErrorApi
+   * implementation may still report them to error tracking services
+   * or other utilities that care about all errors.
+   *
+   * @defaultValue false
+   */
  hidden?: boolean;
 };