mongodb-driver-kotlin-extensions/com.mongodb.kotlin.client.model/Projections/metaSearchHighlights

metaSearchHighlights

fun <T> KProperty<T>.metaSearchHighlights(): Bson

Creates a searchHighlights projection for the given property, for use with {@link Aggregates#search(SearchOperator, SearchOptions)} / {@link Aggregates#search(SearchCollector, SearchOptions)}. Calling this method is equivalent to calling {@link #meta(String, String)} with {@code "searchHighlights"} as the argument.

Return

the projection

See also

SearchHighlight

@mongodb.atlas.manual atlas-search/highlighting/ Highlighting