Debug Value Scrubbing

Plite formats some thrown error details with document values and nodes. Text fields are redacted by default. Apps that need stricter diagnostics can install a scrubber for additional fields.

Install A Scrubber

import { setDebugValueScrubber } from "@platejs/plite";
 
setDebugValueScrubber((key, value) => {
  if (key === "text" || key === "src") return "[redacted]";
  return value;
});Copy

import { setDebugValueScrubber } from "@platejs/plite";
 
setDebugValueScrubber((key, value) => {
  if (key === "text" || key === "src") return "[redacted]";
  return value;
});Copy

Pass null or undefined to restore the default scrubber.

setDebugValueScrubber(null);Copy

setDebugValueScrubber(null);Copy

API

setDebugValueScrubber: (scrubber: DebugValueScrubber | null | undefined) => void

Set the function used before Plite formats debug values.

type DebugValueScrubber = (key: string, value: unknown) => unknown;

The custom scrubber runs before Plite's default text redaction. Return the original value to let the default scrubber handle it.