Interface: FreeTextRedactionResult

The successful result of a FreeTextRedactor: the redacted prose to write back in place. To decline a locus (so the engine fails closed and blocks it), a redactor returns null / undefined or throws - it never returns un-redacted text expecting the engine to catch a miss.

Example

import { type FreeTextRedactionResult } from "@cosyte/deid";

const result: FreeTextRedactionResult = { text: "patient [REDACTED]…" };

Properties

text

readonly text: string

The redacted prose. May be an empty string (all prose removed); that is a valid redaction.