daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
4.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Interface: ISearchService
internal.ISearchService
Implemented by
Properties
options
• options: Record<string, unknown>
Defined in
packages/types/dist/search/interface.d.ts:2
Methods
addDocuments
▸ addDocuments(indexName, documents, type): unknown
Used to index documents by the search engine provider
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
documents |
unknown |
documents array to be indexed |
type |
string |
of documents to be added (e.g: products, regions, orders, etc) |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:23
createIndex
▸ createIndex(indexName, options): unknown
Used to create an index
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
options |
unknown |
the options |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:9
deleteAllDocuments
▸ deleteAllDocuments(indexName): unknown
Used to delete all documents
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:44
deleteDocument
▸ deleteDocument(indexName, document_id): unknown
Used to delete document
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
document_id |
string | number |
the id of the document |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:38
getIndex
▸ getIndex(indexName): unknown
Used to get an index
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name. |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:15
replaceDocuments
▸ replaceDocuments(indexName, documents, type): unknown
Used to replace documents
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name. |
documents |
unknown |
array of document objects that will replace existing documents |
type |
string |
type of documents to be replaced (e.g: products, regions, orders, etc) |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:31
search
▸ search(indexName, query, options): unknown
Used to search for a document in an index
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
query |
null | string |
the search query |
options |
unknown |
any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:54
updateSettings
▸ updateSettings(indexName, settings): unknown
Used to update the settings of an index
Parameters
| Name | Type | Description |
|---|---|---|
indexName |
string |
the index name |
settings |
unknown |
settings object |
Returns
unknown
returns response from search engine provider
Defined in
packages/types/dist/search/interface.d.ts:61