@hegeldev/hegel
    Preparing search index...

    Interface TextOptions

    Options for character filtering, shared between text() and characters().

    alphabet is a shorthand that sets includeCharacters and clears categories. It cannot be combined with other character filtering options.

    interface TextOptions {
        alphabet?: string;
        categories?: readonly string[];
        codec?: string;
        excludeCategories?: readonly string[];
        excludeCharacters?: string;
        includeCharacters?: string;
        maxCodepoint?: number;
        maxSize?: number;
        minCodepoint?: number;
        minSize?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alphabet? categories? codec? excludeCategories? excludeCharacters? includeCharacters? maxCodepoint? maxSize? minCodepoint? minSize?

    Properties

    alphabet?: string

    Restrict to characters in this explicit set. Mutually exclusive with other character options.

    categories?: readonly string[]

    Include only characters from these Unicode general categories (e.g. ["L", "Nd"]).

    codec?: string

    Restrict to characters encodable in this codec (e.g. "ascii", "utf-8", "latin-1").

    excludeCategories?: readonly string[]

    Exclude characters from these Unicode general categories.

    excludeCharacters?: string

    Always exclude these specific characters.

    includeCharacters?: string

    Always include these specific characters.

    maxCodepoint?: number

    Maximum Unicode codepoint (inclusive).

    maxSize?: number
    minCodepoint?: number

    Minimum Unicode codepoint (inclusive).

    minSize?: number

    Settings

    Member Visibility

    On This Page

    Properties