Interface TextExcerptOptions

interface TextExcerptOptions {
    flags?: string;
    group?: string | number;
    match?: number;
    maxLength?: number;
    pattern?: string;
}

Properties

flags?: string

Supported flags: i (case insensitive), m (line anchors), s (dot includes newline).

group?: string | number

Capture number or name. Defaults to 0, the complete match.

match?: number

One-based, non-overlapping match number. Defaults to 1; maximum 10,000.

maxLength?: number

Grapheme limit, default 200. Invalid, negative, or zero lengths return empty text.

pattern?: string

RE2 pattern, without / delimiters. Omit to truncate the entire text.