Skip to main contentreport-toolkit

constants

A grip of constants used throughout the project.

Index

Type aliases

Variables

Type aliases

SEVERITIES

Ƭ SEVERITIES: number

Potential severities of Messages reported by the inspector.

Variables

Const DEFAULT_DIFF_EXCLUDE

• DEFAULT_DIFF_EXCLUDE: keyof string[]

Typically useless keypaths to explicitly omit from diffs. Anything here should be more specific than what’s in DEFAULT_DIFF_INCLUDE.

Const DEFAULT_DIFF_INCLUDE

• DEFAULT_DIFF_INCLUDE: keyof string[]

Things we explicitly want to show in the diffs. Use DEFAULT_DIFF_EXCLUDE to exclude any child properties of these.

Const DEFAULT_SEVERITY

• DEFAULT_SEVERITY: “warning”

Default severity across system

Const ERROR

• ERROR: “error”

“Error” severity. The highest severity, and the default.

Const INFO

• INFO: “info”

“Info” severity. The lowest severity.

Const NAMESPACE

• NAMESPACE: “report-toolkit”

Project namespace

Const NO_FILEPATH

• NO_FILEPATH: “(no filepath)”

Text to use in display if no filepath found

Const REDACTED_TOKEN

• REDACTED_TOKEN: ”[REDACTED]”

The string token used to replace secrets when redacting from a report.

Const REPORT_KNOWN_ROOT_PROPERTIES

• REPORT_KNOWN_ROOT_PROPERTIES: keyof string[]

Known root properties of a Diagnostic Report. To be processed, an object must have all of these properties. The current list in order:

  • header
  • javascriptStack
  • nativeStack
  • javascriptHeap
  • resourceUsage
  • libuv
  • environmentVariables
  • userLimits
  • sharedObjects

Const SEVERITIES

• SEVERITIES: Readonly‹object›

Potential severities of Messages reported by the inspector.

enum {number}

Const SHORT_NAMESPACE

• SHORT_NAMESPACE: “rtk”

Short project namespace

Const WARNING

• WARNING: “warning”

“Warning” severity.

Edit this page on GitHub