Flare Flare Laravel Laravel PHP PHP JavaScript JavaScript React React Vue Vue Protocol Protocol

API reference

The Vue integration builds on top of the core JavaScript client. For the base API reference (method chaining, configuration, using the Flare class directly), see the JavaScript API reference.

Exports

import {
    FlareErrorBoundary,
    flareVue,
    DEFAULT_PROPS_DENYLIST,
} from '@flareapp/vue';
Export Description
flareVue Vue plugin that hooks into app.config.errorHandler and reports errors to Flare. Accepts an optional options object. See Error handling for details.
FlareErrorBoundary Component that uses onErrorCaptured to catch errors from descendants and render a fallback slot. See Error boundary for details.
DEFAULT_PROPS_DENYLIST The RegExp used by default to redact sensitive prop keys (see pattern below). Exported so you can compose your own denylist on top of it.

The default denylist matches the following sensitive key patterns:

/password|passwd|pwd|token|secret|authorization|\bauth\b|bearer|oauth|credentials?|cookie|api[-_]?key|private[-_]?key|session|csrf|xsrf|\bpin\b|\bssn\b|card[-_]?number|\bcvv\b/i

TypeScript

The @flareapp/vue package ships with full TypeScript support. The following types are exported:

import type {
    ComponentHierarchyFrame,
    ErrorOrigin,
    FlareErrorBoundaryFallbackProps,
    FlareErrorBoundaryHookParams,
    FlareVueContext,
    FlareVueOptions,
    FlareVueWarningContext,
    RouteContext,
    RouteParamValue,
    RouteQueryValue,
} from '@flareapp/vue';
Type Description
ComponentHierarchyFrame One entry in componentHierarchyFrames: component, file, and optional props.
ErrorOrigin Normalized category derived from Vue's info string: "setup" | "render" | "lifecycle" | "event" | "watcher" | "unknown".
FlareErrorBoundaryFallbackProps Props passed to the fallback scoped slot (error, componentHierarchy, componentHierarchyFrames, componentProps, resetErrorBoundary).
FlareErrorBoundaryHookParams Parameters shared by every lifecycle hook: error, instance, info.
FlareVueContext Shape of the context object passed to beforeSubmit / afterSubmit and attached to the report.
FlareVueOptions Options accepted by flareVue() (hooks, attachProps, propsMaxDepth, propsDenylist, replaceDefaultDenylist, captureWarnings).
FlareVueWarningContext Shape of the context reported for Vue warnings when captureWarnings is enabled.
RouteContext Route information attached to the report when Vue Router is detected.
RouteParamValue string | string[] - matches Vue Router's route-param shape, including repeated params.
RouteQueryValue string | null - individual query value, where null represents keys without a value (?flag). In RouteContext.query, values may also be RouteQueryValue[] for repeated keys (e.g. ?tag=a&tag=b).
Resolving bundled code Error boundary