Interface: CosmographSearchOptions

Properties

fields

fields: string[]

Point fields to search.

limit?

optional limit: number

Maximum number of results to return. Defaults to 100 for searchPoints and undefined for getPointIndicesBySearch.

offset?

optional offset: number

Number of matching results to skip.

Default

0

match?

optional match: "contains" | "prefix" | "exact"

How the query should match stringified field values.

Default

'contains'

caseSensitive?

optional caseSensitive: boolean

Whether matching should preserve character case.

Default

false

returnFields?

optional returnFields: string[]

Point fields to include in returned rows. Defaults to all fields. Only used by searchPoints.

orderBy?

optional orderBy: "relevance" | "index"

How matching rows should be ordered.

Default

'relevance'