const builder = new lunr.Builder()   // if you need to,
builder.metadataWhitelist = ['tags'] // you can customize the builder that will be used internally

const lunrSearch = new LunrSearch('myfreshdeskdomain', 'freshdeskusername', 'freshdeskpassword', {
  builder, // pass the custom builder if needed
  plugins: [myCustomBuilderPlugin],
  editDistance: 2 // in case your users can't type very well :)
})

lunrSearch.buildIndex().then(() => mySearchBar.addEventListener('input', () => lunrSeach.search(mySearchBar.value))

const opts = {domain: 'freshdeskdomain', user: 'username', pass: 'password'}
const builder = new lunr.Builder() // custom builder, etc.
const indexPromise = LunrSearch.buildIndex({builder, ...opts}) // you can pass a custom builder into the static methods too

indexPromise.then(() => mySearchBar.addEventListener('input', () => lunrSeach.search(mySearchBar.value))

Members

static VERSION :string

lunr.js, line 69

The package version.

builder :lunr.Builder

lunr.js, line 115

a custom builder to use

docs :Object

lunr.js, line 77

the fetched documents the keys are the document ID and the value is the document. useful for getting info about a search result.

domain :string

lunr.js, line 88

the domain to use for all fetch requests

editDistance :number

lunr.js, line 133

a default edit distance to use in search queries

Default Value:

• 0

index :lunr.Index

lunr.js, line 143

The built lunr index.

pass :string

lunr.js, line 106

the password to use for all fetch requests

plugins :Array.<Plugin>

lunr.js, line 124

a list of plugins to use

user :string

lunr.js, line 97

the username to use for all fetch requests

Methods

async, static buildIndex(optionsopt) → {lunr.Index}

lunr.js, line 368

Builds an index and returns it. If no docs are supplied, they will be fetched.

Parameters:

Name	Type	Attributes	Default	Description
options	Object	<optional>	{}	Properties Name Type Attributes Description domain string <optional> the domain of the API to make the request to user string <optional> the username for the API pass string <optional> the password for the API docs Array.<Object> <optional> list of docs to build the index with builder lunr.Builder <optional> the builder to use for building the index plugins Array.<Plugin> <optional> a list of plugins

Returns:

lunr.Index -

the built index

async, static exportIndex(optionsopt) → {string}

lunr.js, line 342

Builds then serializes and exports a lunr index.

Parameters:

Name	Type	Attributes	Default	Description
options	Object	<optional>	{}	Properties Name Type Attributes Description domain string <optional> the domain of the API to make the request to user string <optional> the username for the API pass string <optional> the password for the API builder lunr.Builder <optional> the builder to use for building the index plugins Array.<function()> <optional> a list of plugins for the builder to use

Returns:

string -

the serialized index

async, static fetch(optionsopt) → {Array.<Object>}

lunr.js, line 397

Fetches some documents that are ready to be indexed.

Parameters:

Name	Type	Attributes	Default	Description
options	Object	<optional>	{}	Properties Name Type Attributes Description domain string <optional> the domain of the API to make the request to user string <optional> the username for the API pass string <optional> the password for the API plugins Array.<Plugin> <optional> a list of plugins

Returns:

Array.<Object> -

the array of Objects to be indexed

async, static getIndex(url, authopt) → {lunr.Index}

lunr.js, line 295

Gets and imports an index fram a URL.

Parameters:

Name	Type	Attributes	Default	Description
url	string			the URL of the endpoint
auth	Object	<optional>	{}	authentication details for the API Properties Name Type Attributes Description user string <optional> the username for the API pass string <optional> the password for the API

Returns:

lunr.Index

static importIndex(json) → {lunr.Index}

lunr.js, line 307

Imports an exported lunr index and returns it.

Parameters:

Name	Type	Description
json	string	the stringified index to import

Returns:

lunr.Index

static isSupported(pluginsopt) → {Boolean}

lunr.js, line 420

Checks to see if certain functions are defined.

Parameters:

Name	Type	Attributes	Description
plugins	Array.<Plugin>	<optional>	a list of plugins

Returns:

Boolean

async, static postIndex(index, url, authopt) → {axios.Response}

lunr.js, line 324

Posts an exported index to a URL.

Parameters:

Name	Type	Attributes	Default	Description
index	lunr.Index			the index to be posted
url	string			the URL of the endpoint
auth	Object	<optional>	{}	authentication details for the API Properties Name Type Attributes Description user string <optional> the username for the API pass string <optional> the password for the API

Returns:

axios.Response

static search(query, index, optionsopt) → {Array.<Result>}

lunr.js, line 279

Searches the given index with the given query. If query is falsey no search is performed.

Parameters:

Name	Type	Attributes	Default	Description
query	string			the query to search with
index	lunr.Index			an index to use for the search
options	Object	<optional>	{}	Properties Name Type Attributes Default Description editDistance number <optional> 1 the edit distance to use for the search

Returns:

Array.<Result> -

an array of search results

async buildIndex() → {lunr.Index}

lunr.js, line 236

Builds an index and stores it.

Returns:

lunr.Index -

the built index

async exportIndex() → {Promise.<string>}

lunr.js, line 224

Serializes and exports a lunr index. If the index exists locally, it will not be built. Call #buildIndex to build a fresh index. If the index does not already exist, it will be built asynchronously.

Returns:

Promise.<string> -

the serialized index

async fetch() → {Array.<Object>}

lunr.js, line 254

Fetches some documents that are ready to be indexed.

Returns:

Array.<Object> -

the array of Objects to be indexed

async getIndex(url, authopt) → {lunr.Index}

lunr.js, line 179

Gets and imports an index fram a URL.

Parameters:

Name	Type	Attributes	Default	Description
url	string			the URL of the endpoint
auth	Object	<optional>	{}	authentication details for the API Properties Name Type Attributes Description user string <optional> the username for the API pass string <optional> the password for the API

Returns:

lunr.Index

importIndex(json) → {void}

lunr.js, line 192

Imports an exported lunr index and stores it.

Parameters:

Name	Type	Description
json	string	the index to import as a json string

Returns:

void

async postIndex(url, authopt) → {axios.Response}

lunr.js, line 210

Posts index to a URL. If the index exists locally, it will not be built. Call LunrSearch#buildIndex to build a fresh index. If the index does not already exist, it will be built asynchronously.

Parameters:

Name	Type	Attributes	Default	Description
url	string			the URL of the endpoint
auth	Object	<optional>	{}	authentication details for the API Properties Name Type Attributes Description user string <optional> the username for the API pass string <optional> the password for the API

Returns:

axios.Response

search(query, optionsopt) → {Array.<Result>}

lunr.js, line 163

Searches the index with the given query.

Parameters:

Name	Type	Attributes	Default	Description
query	string			the query to search with
options	Object	<optional>	{}	Properties Name Type Attributes Description editDistance number <optional> the edit distance to use for the search

Returns:

Array.<Result> -

an array of search results

Type Definitions

Plugin

lunr.js, line 13

Properties:

Name	Type	Description
plugin	function	a lunr builder plugin
fetch	function	a function to fetch documents
isSupported	function	checks whether the plugin is supported in the current environment

Result

lunr.js, line 21

Properties:

Name	Type	Description
document	Object	the document that was matched
source	Object	describes the source of the document Properties Name Type Description type string the type of the document source, examples are 'forum' or 'solution' url string the URL that the document was fetched from
result	lunr.Index~Result	the lunr search result