search
const search: { query: Promise<SearchResults>;};Defined in: domains/search.ts:27
Type Declaration
Section titled “Type Declaration”query()
Section titled “query()”query(text, options?): Promise<SearchResults>;Search across multiple entity types simultaneously.
Returns results grouped by type. Use options.types to restrict the search
to specific entities and options.limit to control result set size per type.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
text |
string |
The search string. |
options |
SearchOptions |
Optional filter for entity types and result limit. |
Returns
Section titled “Returns”Promise<SearchResults>
A SearchResults object with a result set for each entity type.
Throws
Section titled “Throws”MobileLockerError on network failure or server error.
Example
Section titled “Example”const results = await mobilelocker.search.query('Acme', { types: ['customers'], limit: 10 })results.customers.results.forEach(c => console.log(c.name))