@arbidocs/blocks 0.5.59 → 0.5.60

package/dist/settings/error-report.d.ts

@@ -0,0 +1,26 @@
+/** One titled block of `label: value` lines in an error report (the host's own context). */
+export interface ErrorReportSection {
+    title: string;
+    rows: Array<[label: string, value: string]>;
+    /** Column the values start at. Default: the longest label plus its colon, plus three spaces. */
+    labelWidth?: number;
+}
+export interface ErrorReportInput {
+    error: Error | null;
+    /** React's component stack (`ErrorInfo.componentStack`), when known. */
+    componentStack?: string | null;
+    /** Which boundary caught it. */
+    componentName?: string;
+    /** The host's context between the error and the stack, e.g. navigation, ids, auth state. */
+    sections?: ErrorReportSection[];
+    /** Defaults to the current time, URL and user agent; tests pin them. */
+    timestamp?: string;
+    url?: string;
+    userAgent?: string;
+}
+/**
+ * A short plain-text error report for support: the error, the host's context, the first lines of
+ * the stack and the nearest components, and the environment. It leaves out props, state and full
+ * stacks on purpose, since they can hold the user's content.
+ */
+export declare function formatErrorReport({ error, componentStack, componentName, sections, timestamp, url, userAgent, }: ErrorReportInput): string;