Interface FormatPathsOptions

Options for formatPaths and formatPath; every field has a default.

interface FormatPathsOptions {
    captures?: ReadonlyMap<string, readonly Path[]>;
    indent?: boolean;
    elementFormat?: PathElementFormat;
    maxLength?: number;
    lastElementOnly?: boolean;
}

Properties

captures?: ReadonlyMap<string, readonly Path[]>

Named captures to list (sorted by name) before the paths.

indent?: boolean

Indent each element by its depth (on by default).

How each element is rendered ("summary" by default).

maxLength?: number

Truncate each summary to this many UTF-16 code units, with an ellipsis.

lastElementOnly?: boolean

Render only the last element of each path, unindented.