--- displayed_sidebar: servicesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # SearchService ## Constructors #### constructor `**new SearchService**(«destructured», options)` ##### Parameters ## Properties `", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ]} /> ## Accessors #### options **options**: [object Object] ## Methods #### addDocuments `**addDocuments**(indexName, documents, type): Promise<void>` Used to index documents by the search engine provider ##### Parameters ##### Returns Promise<void> ___ #### createIndex `**createIndex**(indexName, options): Promise<void>` Used to create an index ##### Parameters ##### Returns Promise<void> ___ #### deleteAllDocuments `**deleteAllDocuments**(indexName): Promise<void>` Used to delete all documents ##### Parameters ##### Returns Promise<void> ___ #### deleteDocument `**deleteDocument**(indexName, document_id): Promise<void>` Used to delete document ##### Parameters ##### Returns Promise<void> ___ #### getIndex `**getIndex**(indexName): Promise<void>` Used to get an index ##### Parameters ##### Returns Promise<void> ___ #### replaceDocuments `**replaceDocuments**(indexName, documents, type): Promise<void>` Used to replace documents ##### Parameters ##### Returns Promise<void> ___ #### search `**search**(indexName, query, options): Promise<{ hits: unknown[] }>` Used to search for a document in an index ##### Parameters ##### Returns Promise<{ hits: unknown[] }> ___ #### updateSettings `**updateSettings**(indexName, settings): Promise<void>` Used to update the settings of an index ##### Parameters ##### Returns Promise<void>