Interface SearchService

Provides search functionality (use search-api.SearchService OSGi service name).

interface SearchService {
hasStore(storeId: string): boolean;
search(query: string, options?: SearchOptions): Search;
}

Index

Methods

hasStore search

Methods

hasStore

hasStore(storeId: string): boolean
Returns true if the service knows a store with the given ID.
Parameters
- storeId: string
Returns boolean
- Defined in api.ts:13

search

search(query: string, options?: SearchOptions): Search
Searches items on one or more data sources using the given query.
Parameters
- query: string
  the search query
- Optionaloptions: SearchOptions
  options to customize the search
Returns Search
An object that represents the state of the search.
- Defined in api.ts:22