TomTom Maps for JavaScript
    Preparing search index...

    Type Alias AutocompleteGenericSearchSegment

    Base properties shared across all autocomplete segment types.

    Contains the entity type, value, and mapping information showing how the segment relates to the original input query.

    type AutocompleteGenericSearchSegment = {
        matches: AutocompleteSearchMatches;
        type: AutocompleteSearchSegmentType;
        value: string;
    }
    Index

    Properties

    Properties

    Mapping between the input query and this segment.

    Shows which part(s) of the original query correspond to this recognized entity.

    The type of detected entity.

    Currently detects: brand, category, and plaintext. Additional types may be added in future versions.

    value: string

    The value of the detected entity.

    May be a category name, brand name, or unrecognized text. For brand segments, this value can be used with the poiBrands parameter in other search endpoints to filter POI results.