Type Alias TextPipelineOptions

Pipeline configuration; omitted categories enable all capabilities except consumer spacing.

type TextPipelineOptions = {
    categories?: readonly FormattingCategory[];
    protectedContent?: readonly string[];
    settings?: Readonly<Record<string, TextRuleSettings>>;
}

Index

Properties

categories? protectedContent? settings?

Properties

`Optional` `Readonly`categories

categories?: readonly FormattingCategory[]

Explicit selection, including an empty list to disable text rules and hyphenation.

`Optional` `Readonly`protectedContent

protectedContent?: readonly string[]

Nonempty literal text preserved alongside recognized URLs and email addresses.

`Optional` `Readonly`settings

settings?: Readonly<Record<string, TextRuleSettings>>

Per-rule setting overrides. Unknown IDs or setting names are rejected.