API Reference

Core

Index

import { Index } from 'meteor/easysearch:core'

new Index(configuration)

Constructor for creating an index.

Configuration

• collection: Required, data that contains the searchable data
• fields: Required, fields to search for on the document
• engine: Required, engine to use for search
• permission(options): Manage permission by returning a boolean
• defaultSearchOptions: The default search options as an object
• countUpdateIntervalMs: Update interval of search count (if false => not reactive)

index.search(searchDefinition, [options])

Search the index with the given search definition.

searchDefinition

A search string (or object for mongo based engines) that defines what to search for.

options

• limit: Limit as a number, by default 10
• skip: Offset as a number, by default 0
• props: An object of custom props, such as facets and other

Components

Index

index.getComponentDict([componentName])

Get a component dictionary that is a ReactiveDict used for searching by the EasySearch Components.

componentName

Name of the component as a string

index.getComponentMethods([componentName])

Returns an object of convenient methods for search that the EasySearch Components also use.

componentName

Name of the component as a string