Elasticlunr.js

http://elasticlunr.com/
Admin
Elasticlunr.js is a lightweight full-text search engine in JavaScript for browser search and offline...
Tokens:36,000
Snippets:332
Trust Score:5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Search Configuration Example

Source: http://elasticlunr.com/example/index.html

This is an example of how to configure search fields and boolean logic for Elasticlunr.js. Adjust field boosts to prioritize certain fields in search results.

```json
{
    "fields": {
        "title": {"boost": 2},
        "body": {"boost": 1}
    },
    "boolean": "OR"
}
```

--------------------------------

### Install Elasticlunr in Node.js

Source: http://elasticlunr.com/docs/index.html

Installs the elasticlunr package using npm. This is the first step to using Elasticlunr in a Node.js environment.

```bash
npm install elasticlunr
```

--------------------------------

### Search with Query-Time Boosting (Simple)

Source: http://elasticlunr.com/

Perform a search query with query-time boosting. This example demonstrates boosting the 'title' field more than the 'body' field.

```javascript
index.search("Oracle database", {
    fields: {
        title: {boost: 2},
        body: {boost: 1}
    }
});
```

--------------------------------

### Search Results Example

Source: http://elasticlunr.com/docs/index.html

Example of the structure of search results returned by the index.search() method, including the document reference and its relevance score.

```json
[{
    "ref": 1,
    "score": 0.5376053707962494
},
{
    "ref": 2,
    "score": 0.5237481076838757
}]
```

--------------------------------

### Search with Query-Time Boosting

Source: http://elasticlunr.com/docs/configuration.js.html

Example of performing a search with custom query-time boosting applied to specific fields. This allows certain fields to have a greater impact on search results.

```javascript
idx.search('oracle database', {fields: {title: {boost: 2}, body: {boost: 1}}});
```

--------------------------------

### Initialize a SortedSet

Source: http://elasticlunr.com/docs/sorted_set.js.html

Creates a new empty SortedSet. Use this to start a new set of unique, sorted elements.

```javascript
lunr.SortedSet = function () {
  this.length = 0
  this.elements = []
}
```

--------------------------------

### elasticlunr.Pipeline.prototype.get

Source: http://elasticlunr.com/docs/pipeline.js.html

Get the pipeline if user want to check the pipeline.

```APIDOC
## elasticlunr.Pipeline.prototype.get()

### Description
Get the pipeline if user want to check the pipeline.

### Response
#### Success Response (200)
- **return** (Array) - The current pipeline queue.

### Request Example
```javascript
elasticlunr.Pipeline.prototype.get = function () {
  return this._queue;
};
```
```

--------------------------------

### get

Source: http://elasticlunr.com/docs/configuration.js.html

Retrieves the current user search configuration.

```APIDOC
## get

### Description
Get current user configuration.

### Method
`elasticlunr.Configuration.prototype.get()`

### Response
#### Success Response (200)
- **config** (Object) - The current configuration object.
```

--------------------------------

### Search with Token Expansion

Source: http://elasticlunr.com/

Enable token expansion to increase recall. Expanded query tokens will have their results penalized. This example also sets specific boolean logic for fields and the overall query.

```javascript
index.search("micro", {
    fields: {
        title: {boost: 2, bool: "AND"},
        body: {boost: 1}
    },
    bool: "OR",
    expand: true
});
```

--------------------------------

### Get Current User Configuration

Source: http://elasticlunr.com/docs/configuration.js.html

Retrieves the current user search configuration object. This is useful for inspecting or saving the current settings.

```javascript
elasticlunr.Configuration.prototype.get = function () {
  return this.config;
};
```

--------------------------------

### Get Index Fields

Source: http://elasticlunr.com/docs/index.js.html

Retrieves a copy of the fields currently configured for the index. This is useful for understanding the structure of the indexed data.

```javascript
elasticlunr.Index.prototype.getFields = function () {
  return this._fields.slice();
};
```

--------------------------------

### Initialize and Use Elasticlunr in Node.js

Source: http://elasticlunr.com/docs/index.html

Demonstrates how to require elasticlunr, initialize an index with fields, add documents, and perform a search in a Node.js environment.

```javascript
var elasticlunr = require('elasticlunr');

var index = elasticlunr(function () {
    this.addField('title')
    this.addField('body')
});

var doc1 = {
    "id": 1,
    "title": "Oracle released its latest database Oracle 12g",
    "body": "Yestaday Oracle has released its new database Oracle 12g, this would make more money for this company and lead to a nice profit report of annual year."
}

var doc2 = {
    "id": 2,
    "title": "Oracle released its profit report of 2015",
    "body": "As expected, Oracle released its profit report of 2015, during the good sales of database and hardware, Oracle's profit of 2015 reached 12.5 Billion."
}

index.addDoc(doc1);
index.addDoc(doc2);

index.search("Oracle database profit");

```

--------------------------------

### Initialize Configuration

Source: http://elasticlunr.com/docs/configuration.js.html

Constructs a new Configuration object. Parses user-provided JSON configuration or falls back to default settings if parsing fails. Requires fields to be defined.

```javascript
elasticlunr.Configuration = function (config, fields) {
  var config = config || '';

  if (fields == undefined || fields == null) {
    throw new Error('fields should not be null');
  }

  this.config = {};

  var userConfig;
  try {
    userConfig = JSON.parse(config);
    this.buildUserConfig(userConfig, fields);
  } catch (error) {
    elasticlunr.utils.warn('user configuration parse failed, will use default configuration');
    this.buildDefaultConfig(fields);
  }
};
```

--------------------------------

### Initialize DocumentStore

Source: http://elasticlunr.com/docs/document_store.js.html

Creates a new DocumentStore instance. Optionally configures whether to save the original JSON documents. Defaults to saving documents if not specified.

```javascript
elasticlunr.DocumentStore = function (save) {
  if (save === null || save === undefined) {
    this._save = true;
  } else {
    this._save = save;
  }

  this.docs = {};
  this.docInfo = {};
  this.length = 0;
};
```

--------------------------------

### Create a Search Index

Source: http://elasticlunr.com/

Initialize a new elasticlunr index with specified fields and a reference field.

```javascript
var index = elasticlunr(function () {
    this.addField('title');
    this.addField('body');
    this.setRef('id');
});
```

--------------------------------

### Get Pipeline Functions

Source: http://elasticlunr.com/docs/pipeline.js.html

Returns the current array of functions registered in the pipeline.

```javascript
elasticlunr.Pipeline.prototype.get = function () {
  return this._queue;
};
```

--------------------------------

### Get current tokenizer separator

Source: http://elasticlunr.com/docs/tokenizer.js.html

Retrieves the currently active separator used by the tokenizer for splitting strings into tokens.

```javascript
elasticlunr.tokenizer.getSeperator = function() {
    return elasticlunr.tokenizer.seperator;
}
```

--------------------------------

### Initialize Index with Spanish Language Support (Browser)

Source: http://elasticlunr.com/docs/index.html

Initializes an Elasticlunr index and configures it to use Spanish language stemming and processing. Replace `elasticlunr.de` with `elasticlunr.es` for Spanish.

```javascript
this.use(elasticlunr.es);
```

--------------------------------

### Initialize Index with German Language Support (Browser)

Source: http://elasticlunr.com/docs/index.html

Initializes an Elasticlunr index and configures it to use German language stemming and processing. This is done using the `this.use()` method within the index definition.

```javascript
var index = elasticlunr(function () {
    // use the language (de)
    this.use(elasticlunr.de);
    // then, the normal elasticlunr index initialization
    this.addField('title')
    this.addField('body')
});
```

--------------------------------

### Get Document Frequency of a Token

Source: http://elasticlunr.com/docs/inverted_index.js.html

Retrieves the number of documents a token appears in. Returns 0 if the token is not found in the index.

```javascript
elasticlunr.InvertedIndex.prototype.getDocFreq = function (token) {
  var node = this.getNode(token);

  if (node == null) {
    return 0;
  }

  return node.df;
};
```

--------------------------------

### Get Documents Containing a Token

Source: http://elasticlunr.com/docs/inverted_index.js.html

Retrieves all document references that contain a specific token. If the token is not found, an empty object is returned.

```javascript
elasticlunr.InvertedIndex.prototype.getDocs = function (token) {
  var node = this.getNode(token);
  if (node == null) {
    return {};
  }

  return node.docs;
};
```

--------------------------------

### Build a Simple Search Index

Source: http://elasticlunr.com/docs/index.html

Create a new search index instance and define the fields to be indexed and the document reference field. The default reference field is 'id'.

```javascript
var index = elasticlunr(function () {
    this.addField('title');
    this.addField('body');
    this.setRef('id');
});
```

```javascript
var index = elasticlunr();
index.addField('title');
index.addField('body');
index.setRef('id');
```

--------------------------------

### Pipeline Constructor

Source: http://elasticlunr.com/docs/pipeline.js.html

Initializes a new instance of the Pipeline with an empty queue for functions.

```APIDOC
## Pipeline Constructor

### Description
Initializes a new instance of the Pipeline with an empty queue for functions.

### Signature
elasticlunr.Pipeline()

### Example
```javascript
var pipeline = new elasticlunr.Pipeline();
```
```

--------------------------------

### Get Document Field Length

Source: http://elasticlunr.com/docs/document_store.js.html

Retrieves the stored length of a specific field for a given document. Returns 0 if the document or field does not exist.

```javascript
elasticlunr.DocumentStore.prototype.getFieldLength = function (docRef, fieldName) {
  if (docRef === null || docRef === undefined) return 0;

  if (!(docRef in this.docs)) return 0;
  if (!(fieldName in this.docInfo[docRef])) return 0;
  return this.docInfo[docRef][fieldName];
};
```

--------------------------------

### DocumentStore Constructor

Source: http://elasticlunr.com/docs/document_store.js.html

Initializes a new instance of the DocumentStore. You can configure whether to store the original JSON document.

```APIDOC
## elasticlunr.DocumentStore()

### Description
Initializes a new instance of the DocumentStore. The `save` option determines if the original JSON document should be stored.

### Parameters
#### Options
- **save** (Boolean) - Optional - If true, the original JSON document will be stored. Defaults to true.
```

--------------------------------

### load

Source: http://elasticlunr.com/docs/pipeline.js.html

Loads a previously serialized pipeline. All functions must be pre-registered.

```APIDOC
## load

### Description
Loads a previously serialized pipeline. All functions to be loaded must already be registered with elasticlunr.Pipeline. An error is thrown if any function from the serialised data has not been registered.

### Method
elasticlunr.Pipeline.load(serialised)

### Parameters
#### Parameters
- **serialised** (Object) - The serialised pipeline to load.

### Returns
- **elasticlunr.Pipeline** - A new pipeline instance loaded with the provided functions.

### Example
```javascript
var serialisedPipeline = ['trimmer', 'stop_word_filter', 'stemmer'];
var pipeline = elasticlunr.Pipeline.load(serialisedPipeline);
```
```

--------------------------------

### Get Term Frequency for Token in Document

Source: http://elasticlunr.com/docs/inverted_index.js.html

Retrieves the frequency of a specific token within a given document. Returns 0 if the token or document reference is not found.

```javascript
elasticlunr.InvertedIndex.prototype.getTermFrequency = function (token, docRef) {
  var node = this.getNode(token);

  if (node == null) {
    return 0;
  }

  if (!(docRef in node.docs)) {
    return 0;
  }

  return node.docs[docRef].tf;
};
```

--------------------------------

### elasticlunr.Index.prototype.use

Source: http://elasticlunr.com/docs/index.js.html

Applies a plugin to the current index, allowing for customization and extension of its behavior.

```APIDOC
## elasticlunr.Index.prototype.use

### Description
Applies a plugin to the current index. A plugin is a function that is called with the index as its context. Plugins can be used to customize or extend the index's behavior. Additional arguments can be passed to the plugin function.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Method Signature
`use(plugin, ...args)`

- **plugin** (Function) - The plugin function to apply. This function will be called with the index as its context (`this`).
- **args** - Additional arguments to pass to the plugin function.

### Request Example
```javascript
// Define a custom plugin
const myPlugin = function (idx, arg1, arg2) {
  // `this` refers to the index instance
  console.log('Plugin applied with args:', arg1, arg2);
  // Extend index functionality here if needed
};

// Create an index and apply the plugin
const idx = elasticlunr(function () {
  this.use(myPlugin, 'customArg1', 'customArg2');
});
```

### Response
- This method applies the plugin to the index and does not return a value.
```

--------------------------------

### Get Registered Function - elasticlunr.js

Source: http://elasticlunr.com/docs/pipeline.js.html

Retrieves a previously registered pipeline function by its label. Returns null if the function is not found. Use this to access functions needed for pipeline operations.

```javascript
elasticlunr.Pipeline.getRegisteredFunction = function (label) {
  if ((label in elasticlunr.Pipeline.registeredFunctions) !== true) {
    return null;
  }

  return elasticlunr.Pipeline.registeredFunctions[label];
};
```

--------------------------------

### Build User Configuration

Source: http://elasticlunr.com/docs/configuration.js.html

Parses and applies user-defined search configuration. It handles global settings for boolean logic and token expansion, as well as field-specific overrides. Warns if a specified field in the configuration is not found in the index.

```javascript
elasticlunr.Configuration.prototype.buildUserConfig = function (config, fields) {
  var global_bool = "OR";
  var global_expand = false;

  this.reset();
  if ('bool' in config) {
    global_bool = config['bool'] || global_bool;
  }

  if ('expand' in config) {
    global_expand = config['expand'] || global_expand;
  }

  if ('fields' in config) {
    for (var field in config['fields']) {
      if (fields.indexOf(field) > -1) {
        var field_config = config['fields'][field];
        var field_expand = global_expand;
        if (field_config.expand != undefined) {
          field_expand = field_config.expand;
        }

        this.config[field] = {
          boost: (field_config.boost || field_config.boost === 0) ? field_config.boost : 1,
          bool: field_config.bool || global_bool,
          expand: field_expand
        };
      } else {
        elasticlunr.utils.warn('field name in user configuration not found in index instance fields');
      }
    }
  } else {
    this.addAllFields2UserConfig(global_bool, global_expand, fields);
  }
};
```

--------------------------------

### Initialize elasticlunr.utils Namespace

Source: http://elasticlunr.com/docs/utils.js.html

This code initializes the `elasticlunr.utils` namespace. It is used as a container for various utility functions.

```javascript
elasticlunr.utils = {};
```

--------------------------------

### Add Token to InvertedIndex

Source: http://elasticlunr.com/docs/inverted_index.js.html

Adds a token and its associated information (document reference and frequency) to the inverted index. If the token already exists, its information is updated. The operation can optionally start from a specific node within the index.

```javascript
elasticlunr.InvertedIndex.prototype.addToken = function (token, tokenInfo, root) {
  var root = root || this.root,
      idx = 0;

  while (idx <= token.length - 1) {
    var key = token[idx];

    if (!(key in root)) root[key] = {docs: {}, df: 0};
    idx += 1;
    root = root[key];
  }

  var docRef = tokenInfo.ref;
  if (!root.docs[docRef]) {
    // if this doc not exist, then add this doc
    root.docs[docRef] = {tf: tokenInfo.tf};
    root.df += 1;
  } else {
    // if this doc already exist, then update tokenInfo
    root.docs[docRef] = {tf: tokenInfo.tf};
  }
};
```

--------------------------------

### Build Default Configuration

Source: http://elasticlunr.com/docs/configuration.js.html

Sets default configuration values for all fields. Each field defaults to a boost of 1, an 'OR' boolean model, and token expansion disabled.

```javascript
elasticlunr.Configuration.prototype.buildDefaultConfig = function (fields) {
  this.reset();
  fields.forEach(function (field) {
    this.config[field] = {
      boost: 1,
      bool: "OR",
      expand: false
    };
  }, this);
};
```

--------------------------------

### Instantiate and Configure elasticlunr Index

Source: http://elasticlunr.com/docs/elasticlunr.js.html

Use this convenience function to create a new elasticlunr index with default pipeline functions (trimmer, stop word filter, stemmer) and a custom configuration function. The config function is called with the index instance as its context and parameter.

```javascript
var idx = elasticlunr(function () {
  this.addField('id');
  this.addField('title');
  this.addField('body');

  //this.setRef('id'); // default ref is 'id'

  this.pipeline.add(function () {
    // some custom pipeline function
  });
});
```

```javascript
var elasticlunr = function (config) {
  var idx = new elasticlunr.Index;

  idx.pipeline.add(
    elasticlunr.trimmer,
    elasticlunr.stopWordFilter,
    elasticlunr.stemmer
  );

  if (config) config.call(idx, idx);

  return idx;
};

elasticlunr.version = "@VERSION";

// only used this to make elasticlunr.js compatible with lunr-languages
// this is a trick to define a global alias of elasticlunr
lunr = elasticlunr;
```

--------------------------------

### Initialize elasticlunr Index

Source: http://elasticlunr.com/docs/index.js.html

Creates a new instance of the elasticlunr search index. This object manages tokens, document lookups, and provides the main API. It initializes internal structures like fields, document store, and event emitter.

```javascript
elasticlunr.Index = function () {
  this._fields = [];
  this._ref = 'id';
  this.pipeline = new elasticlunr.Pipeline;
  this.documentStore = new elasticlunr.DocumentStore;
  this.index = {};
  this.eventEmitter = new elasticlunr.EventEmitter;
  this._idfCache = {};

  this.on('add', 'remove', 'update', (function () {
    this._idfCache = {};
  }).bind(this));
};
```

--------------------------------

### Add All Fields to User Configuration

Source: http://elasticlunr.com/docs/configuration.js.html

Adds all specified fields to the user's search configuration. Use this to define how fields should be boosted, expanded, and their boolean logic for searching.

```javascript
elasticlunr.Configuration.prototype.addAllFields2UserConfig = function (bool, expand, fields) {
  fields.forEach(function (field) {
    this.config[field] = {
      boost: 1,
      bool: bool,
      expand: expand
    };
  }, this);
};
```

--------------------------------

### DocumentStore.load

Source: http://elasticlunr.com/docs/document_store.js.html

Loads a previously serialised document store.

```APIDOC
## elasticlunr.DocumentStore.load(serialisedData)

### Description
Loads a previously serialised document store from the provided data.

### Parameters
#### Path Parameters
- **serialisedData** (Object) - Required - The serialised document store to load.

### Return
- **elasticlunr.DocumentStore** - The loaded document store instance.
```

--------------------------------

### elasticlunr.Pipeline.prototype.run

Source: http://elasticlunr.com/docs/pipeline.js.html

Runs the current list of functions that registered in the pipeline against the input tokens.

```APIDOC
## elasticlunr.Pipeline.prototype.run()

### Description
Runs the current list of functions that registered in the pipeline against the input tokens.

### Parameters
#### Path Parameters
- **tokens** (Array) - Required - The tokens to run through the pipeline.

### Response
#### Success Response (200)
- **return** (Array) - The processed tokens.

### Request Example
```javascript
elasticlunr.Pipeline.prototype.run = function (tokens) {
  var out = [],
      tokenLength = tokens.length,
      pipelineLength = this._queue.length;

  for (var i = 0; i < tokenLength; i++) {
    var token = tokens[i];

    for (var j = 0; j < pipelineLength; j++) {
      token = this._queue[j](token, i, tokens);
      if (token === void 0 || token === null) break;
    };

    if (token !== void 0 && token !== null) out.push(token);
  };

  return out;
};
```
```

--------------------------------

### Search with Query-Time Boosting

Source: http://elasticlunr.com/

Search with query-time boosting to prioritize specific fields. If no fields are specified, all indexed fields are searched.

```javascript
index.search("Oracle database profit", {
    fields: {
        title: {boost: 2},
        body: {boost: 1}
    }
});
```

--------------------------------

### Initialize Pipeline - elasticlunr.js

Source: http://elasticlunr.com/docs/pipeline.js.html

Constructs a new Pipeline instance. Pipelines maintain an ordered queue of functions for token processing. Use this to create a new pipeline for custom text processing.

```javascript
elasticlunr.Pipeline = function () {
  this._queue = [];
};

elasticlunr.Pipeline.registeredFunctions = {};
```

--------------------------------

### Load Serialized DocumentStore

Source: http://elasticlunr.com/docs/document_store.js.html

Reconstructs a DocumentStore instance from previously serialized data. This is useful for loading an index from storage.

```javascript
elasticlunr.DocumentStore.load = function (serialisedData) {
  var store = new this;

  store.length = serialisedData.length;
  store.docs = serialisedData.docs;
  store.docInfo = serialisedData.docInfo;
  store._save = serialisedData.save;

  return store;
};
```

--------------------------------

### clone

Source: http://elasticlunr.com/docs/sorted_set.js.html

Makes a copy of this set.

```APIDOC
## clone

### Description
Makes a copy of this set.

### Method
`lunr.SortedSet.prototype.clone()`

### Response
- Returns a new lunr.SortedSet that is a copy of the original set.
```

--------------------------------

### Perform a Basic Search

Source: http://elasticlunr.com/docs/index.html

Search the index for documents matching a query string. This returns a list of matching documents with their scores.

```javascript
index.search("Oracle database profit");
```

--------------------------------

### reset

Source: http://elasticlunr.com/docs/configuration.js.html

Resets the user search configuration to an empty state.

```APIDOC
## reset

### Description
Reset user search configuration.

### Method
`elasticlunr.Configuration.prototype.reset()`
```

--------------------------------

### Convert Object to String Utility

Source: http://elasticlunr.com/docs/utils.js.html

This utility converts an object to its string representation. It handles `null` and `undefined` by returning an empty string, otherwise it calls the object's `toString` method.

```javascript
elasticlunr.utils.toString = function (obj) {
  if (obj === void 0 || obj === null) {
    return "";
  }

  return obj.toString();
};
```

--------------------------------

### Initialize InvertedIndex

Source: http://elasticlunr.com/docs/inverted_index.js.html

Constructs a new InvertedIndex. Initializes the root node with empty documents and a document frequency of 0.

```javascript
elasticlunr.InvertedIndex = function () {
  this.root = { docs: {}, df: 0 };
};
```

--------------------------------

### elasticlunr()

Source: http://elasticlunr.com/docs/elasticlunr.js.html

A convenience function for instantiating a new elasticlunr.Index and configuring it with default pipeline functions and a custom configuration function. It automatically includes trimmer, stopWordFilter, and stemmer in the pipeline.

```APIDOC
## elasticlunr()

### Description
Convenience function for instantiating a new elasticlunr index and configuring it with the default pipeline functions and the passed config function. When using this convenience function a new index will be created with the following functions already in the pipeline: 1. elasticlunr.trimmer, 2. elasticlunr.StopWordFilter, 3. elasticlunr.stemmer.

### Parameters
#### Option name | Type | Description
---|---|---
config | Function | A function that will be called with the new instance of the elasticlunr.Index as both its context and first parameter. It can be used to customize the instance of new elasticlunr.Index.

### Return
elasticlunr.Index

### Example
```javascript
var idx = elasticlunr(function () {
  this.addField('id');
  this.addField('title');
  this.addField('body');

  this.pipeline.add(function () {
    // some custom pipeline function
  });
});

idx.addDoc({
  id: 1,
  title: 'Oracle released database 12g',
  body: 'Yestaday, Oracle has released their latest database, named 12g, more robust. this product will increase Oracle profit.'
});

idx.search('oracle database');
idx.search('oracle database', {fields: {title: {boost: 2}, body: {boost: 1}}});
```
```

--------------------------------

### Implement Console Warning Utility

Source: http://elasticlunr.com/docs/utils.js.html

This utility function prints a warning message to the console if `console.warn` is available. It ensures that warnings are displayed in environments that support them.

```javascript
elasticlunr.utils.warn = (function (global) {
  return function (message) {
    if (global.console && console.warn) {
      console.warn(message);
    }
  };
})(this);
```

--------------------------------

### Initialize EventEmitter

Source: http://elasticlunr.com/docs/event_emitter.js.html

Initializes a new instance of the EventEmitter. It sets up an empty object to store event handlers.

```javascript
elasticlunr.EventEmitter = function () {
  this.events = {};
};
```

--------------------------------

### elasticlunr.Index.load()

Source: http://elasticlunr.com/docs/index.js.html

Loads a previously serialised index. Issues a warning if the index being imported was serialised by a different version of elasticlunr.

```APIDOC
## load

##### 
method
elasticlunr.Index.load()

Option name | Type | Description  
---|---|---  
serialisedData | Object | The serialised set to load.  
return | elasticlunr.Index |   

Loads a previously serialised index.
Issues a warning if the index being imported was serialised  
by a different version of elasticlunr.
```javascript
elasticlunr.Index.load = function (serialisedData) {
  if (serialisedData.version !== elasticlunr.version) {
    elasticlunr.utils.warn('version mismatch: current ' 
                    + elasticlunr.version + ' importing ' + serialisedData.version);
  }

  var idx = new this;

  idx._fields = serialisedData.fields;
  idx._ref = serialisedData.ref;
  idx.documentStore = elasticlunr.DocumentStore.load(serialisedData.documentStore);
  idx.pipeline = elasticlunr.Pipeline.load(serialisedData.pipeline);
  idx.index = {};
  for (var field in serialisedData.index) {
    idx.index[field] = elasticlunr.InvertedIndex.load(serialisedData.index[field]);
  }

  return idx;
};
```
```

--------------------------------

### SortedSet.prototype.forEach()

Source: http://elasticlunr.com/docs/sorted_set.js.html

Executes a provided function once per sorted set element. Delegates to Array.prototype.forEach.

```APIDOC
## SortedSet.prototype.forEach(fn, ctx)

### Description
Executes a provided function once per sorted set element. Delegates to Array.prototype.forEach and has the same signature.

### Method
prototype.forEach

### Endpoint
this.forEach(fn, ctx)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **fn** (Function) - Required - The function that is called on each element of the set.
- **ctx** (Object) - Optional - An optional object that can be used as the context for the function fn.

### Request Example
```javascript
var set = lunr.SortedSet.load([1, 2, 3]);
set.forEach(function(x) { console.log(x); }); // Logs 1, 2, 3
```

### Response
#### Success Response (200)
This method does not return a value, but executes the provided function for each element.

#### Response Example
None
```

--------------------------------

### add

Source: http://elasticlunr.com/docs/pipeline.js.html

Adds new functions to the end of the pipeline.

```APIDOC
## add

### Description
Adds new functions to the end of the pipeline. Logs a warning if a function has not been registered.

### Method
elasticlunr.Pipeline.prototype.add(functions)

### Parameters
#### Parameters
- **functions** (Function) - Any number of functions to add to the pipeline.

### Example
```javascript
pipeline.add(elasticlunr.trimmer, elasticlunr.stopWordFilter);
```
```

--------------------------------

### elasticlunr.Index.prototype.on()

Source: http://elasticlunr.com/docs/index.js.html

Bind a handler to events being emitted by the index. The handler can be bound to many events at the same time.

```APIDOC
## on

##### 
method
elasticlunr.Index.prototype.on()

Option name | Type | Description  
---|---|---  
[eventName] | String | The name(s) of events to bind the function to.  
fn | Function | The serialised set to load.  

Bind a handler to events being emitted by the index.
The handler can be bound to many events at the same time.
```javascript
elasticlunr.Index.prototype.on = function () {
  var args = Array.prototype.slice.call(arguments);
  return this.eventEmitter.addListener.apply(this.eventEmitter, args);
};
```
```

--------------------------------

### Search Index

Source: http://elasticlunr.com/docs/index.js.html

Searches the index using a query string and optional user configuration. It processes the query through the pipeline, expands query tokens, and returns matching documents with their scores, sorted by relevance. If no query is provided, an empty array is returned.

```javascript
elasticlunr.Index.prototype.search = function (query, userConfig) {
  if (!query) return [];

  var configStr = null;
  if (userConfig != null) {
    configStr = JSON.stringify(userConfig);
  }

  var config = new elasticlunr.Configuration(configStr, this.getFields()).get();

  var queryTokens = this.pipeline.run(elasticlunr.tokenizer(query));

  var queryResults = {};

  for (var field in config) {
    var fieldSearchResults = this.fieldSearch(queryTokens, field, config);
    var fieldBoost = config[field].boost;

    for (var docRef in fieldSearchResults) {
      fieldSearchResults[docRef] = fieldSearchResults[docRef] * fieldBoost;
    }

    for (var docRef in fieldSearchResults) {
      if (docRef in queryResults) {
        queryResults[docRef] += fieldSearchResults[docRef];
      } else {
        queryResults[docRef] = fieldSearchResults[docRef];
      }
    }
  }

  var results = [];
  for (var docRef in queryResults) {
    results.push({ref: docRef, score: queryResults[docRef]});
  }

  results.sort(function (a, b) { return b.score - a.score; });
  return results;
};
```

--------------------------------

### SortedSet Constructor

Source: http://elasticlunr.com/docs/sorted_set.js.html

Initializes a new SortedSet with an empty array of elements and a length of 0.

```APIDOC
## SortedSet()

### Description
Initializes a new SortedSet with an empty array of elements and a length of 0.

### Method
constructor

### Endpoint
lunr.SortedSet()

### Parameters
None

### Request Example
```javascript
var set = lunr.SortedSet()
```

### Response
#### Success Response (200)
- **elements** (Array) - An empty array to store set elements.
- **length** (Number) - The current number of elements in the set, initialized to 0.

#### Response Example
```json
{
  "elements": [],
  "length": 0
}
```
```

--------------------------------

### addListener

Source: http://elasticlunr.com/docs/event_emitter.js.html

Binds one or more handler functions to a specific event name. Multiple events can be subscribed to with a single call.

```APIDOC
## addListener(eventName, ..., fn)

### Description
Binds one or more handler functions to a specific event name. Multiple events can be subscribed to with a single call.

### Parameters
#### Path Parameters
- **eventName** (String) - The name(s) of events to bind this function to.
- **fn** (Function) - The function to call when an event is fired.

### Method
`elasticlunr.EventEmitter.prototype.addListener`
```

--------------------------------

### Include Language Support in Browser

Source: http://elasticlunr.com/docs/index.html

Includes necessary language support scripts for using Elasticlunr with non-English languages in a browser. Ensure these scripts are included before initializing the index.

```html
<script src="lunr.stemmer.support.js"></script>
<script src="lunr.de.js"></script>
```

--------------------------------

### elasticlunr.Pipeline.prototype.before

Source: http://elasticlunr.com/docs/pipeline.js.html

Adds a single function before a function that already exists in the pipeline. Logs a warning if the function has not been registered. Throws an exception if the existing function is not found.

```APIDOC
## elasticlunr.Pipeline.prototype.before()

### Description
Adds a single function before a function that already exists in the pipeline. Logs a warning if the function has not been registered. If existingFn is not found, throw an Exception.

### Parameters
#### Path Parameters
- **existingFn** (Function) - Required - A function that already exists in the pipeline.
- **newFn** (Function) - Required - The new function to add to the pipeline.

### Request Example
```javascript
elasticlunr.Pipeline.prototype.before = function (existingFn, newFn) {
  elasticlunr.Pipeline.warnIfFunctionNotRegistered(newFn);

  var pos = this._queue.indexOf(existingFn);
  if (pos === -1) {
    throw new Error('Cannot find existingFn');
  }

  this._queue.splice(pos, 0, newFn);
};
```
```

--------------------------------

### Basic Search

Source: http://elasticlunr.com/

Perform a simple search query against the index.

```javascript
index.search("Oracle database");
```

--------------------------------

### elasticlunr.Index.prototype.getFields

Source: http://elasticlunr.com/docs/index.js.html

Retrieves a copy of the fields currently configured for the index instance.

```APIDOC
## elasticlunr.Index.prototype.getFields

### Description
Returns an array containing the names of all fields that are currently part of the index configuration.

### Method
`getFields()`

### Returns
- **Array** - A shallow copy of the fields array.
```

--------------------------------

### elasticlunr.Pipeline.prototype.reset

Source: http://elasticlunr.com/docs/pipeline.js.html

Resets the pipeline by removing any existing processors.

```APIDOC
## elasticlunr.Pipeline.prototype.reset()

### Description
Resets the pipeline by removing any existing processors.

### Request Example
```javascript
elasticlunr.Pipeline.prototype.reset = function () {
  this._queue = [];
};
```
```

--------------------------------

### InvertedIndex.prototype.__expandToken()

Source: http://elasticlunr.com/docs/inverted_index.js.html

Expands a token to find all matching tokens in the inverted index.

```APIDOC
## __expandToken(token, root)

### Description
Expands a token to find all matching tokens in the inverted index starting from the given root node. This is an internal method.

### Method
prototype.__expandToken

### Endpoint
N/A (Instance method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **token** (String) - The token to expand.
- **root** (Object, Optional) - An optional node at which to start the expansion. Defaults to the index's root.

### Response
#### Success Response (200)
- **Array** - An array of matching tokens.
```

--------------------------------

### elasticlunr.Pipeline.prototype.after

Source: http://elasticlunr.com/docs/pipeline.js.html

Adds a single function after a function that already exists in the pipeline. Logs a warning if the function has not been registered. Throws an exception if the existing function is not found.

```APIDOC
## elasticlunr.Pipeline.prototype.after()

### Description
Adds a single function after a function that already exists in the pipeline. Logs a warning if the function has not been registered. If existingFn is not found, throw an Exception.

### Parameters
#### Path Parameters
- **existingFn** (Function) - Required - A function that already exists in the pipeline.
- **newFn** (Function) - Required - The new function to add to the pipeline.

### Request Example
```javascript
elasticlunr.Pipeline.prototype.after = function (existingFn, newFn) {
  elasticlunr.Pipeline.warnIfFunctionNotRegistered(newFn);

  var pos = this._queue.indexOf(existingFn);
  if (pos === -1) {
    throw new Error('Cannot find existingFn');
  }

  this._queue.splice(pos + 1, 0, newFn);
};
```
```

--------------------------------

### Load Serialized Pipeline - elasticlunr.js

Source: http://elasticlunr.com/docs/pipeline.js.html

Loads a pipeline from a serialized object. All functions in the serialized data must be pre-registered. Throws an error if an unregistered function is encountered.

```javascript
elasticlunr.Pipeline.load = function (serialised) {
  var pipeline = new elasticlunr.Pipeline;

  serialised.forEach(function (fnName) {
    var fn = elasticlunr.Pipeline.getRegisteredFunction(fnName);

    if (fn) {
      pipeline.add(fn);
    } else {
      throw new Error('Cannot load un-registered function: ' + fnName);
    }
  });

  return pipeline;
};
```

--------------------------------

### Iterate over SortedSet elements

Source: http://elasticlunr.com/docs/sorted_set.js.html

Executes a provided function once for each element in the set. This delegates to Array.prototype.forEach.

```javascript
lunr.SortedSet.prototype.forEach = function (fn, ctx) {
  return this.elements.forEach(fn, ctx)
}
```

--------------------------------

### addAllFields2UserConfig

Source: http://elasticlunr.com/docs/configuration.js.html

Adds all specified fields to the user's search configuration, allowing customization of search behavior for each field.

```APIDOC
## addAllFields2UserConfig

### Description
Adds all fields to user search configuration.

### Method
`elasticlunr.Configuration.prototype.addAllFields2UserConfig(bool, expand, fields)`

### Parameters
#### Path Parameters
- **bool** (String) - Boolean model
- **expand** (String) - Expand model
- **fields** (Array) - fields of index instance
```

--------------------------------

### English Stemmer Implementation

Source: http://elasticlunr.com/docs/stemmer.js.html

This is the core implementation of the PorterStemmer algorithm for English. It processes words to reduce them to their root form.

```javascript
elasticlunr.stemmer = (function(){
  var step2list = {
      "ational" : "ate",
      "tional" : "tion",
      "enci" : "ence",
      "anci" : "ance",
      "izer" : "ize",
      "bli" : "ble",
      "alli" : "al",
      "entli" : "ent",
      "eli" : "e",
      "ousli" : "ous",
      "ization" : "ize",
      "ation" : "ate",
      "ator" : "ate",
      "alism" : "al",
      "iveness" : "ive",
      "fulness" : "ful",
      "ousness" : "ous",
      "aliti" : "al",
      "iviti" : "ive",
      "biliti" : "ble",
      "logi" : "log"
    },

    step3list = {
      "icate" : "ic",
      "ative" : "",
      "alize" : "al",
      "iciti" : "ic",
      "ical" : "ic",
      "ful" : "",
      "ness" : ""
    },

    c = "[^aeiou]",          // consonant
    v = "[aeiouy]",          // vowel
    C = c + "[^aeiouy]*",    // consonant sequence
    V = v + "[aeiou]*",      // vowel sequence

    mgr0 = "^(" + C + ")?" + V + C,               // [C]VC... is m>0
    meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$",  // [C]VC[V] is m=1
    mgr1 = "^(" + C + ")?" + V + C + V + C,       // [C]VCVC... is m>1
    s_v = "^(" + C + ")?" + v;                   // vowel in stem

  var re_mgr0 = new RegExp(mgr0);
  var re_mgr1 = new RegExp(mgr1);
  var re_meq1 = new RegExp(meq1);
  var re_s_v = new RegExp(s_v);

  var re_1a = /^(.+?)(ss|i)es$/;
  var re2_1a = /^(.+?)([^s])s$/;
  var re_1b = /^(.+?)eed$/;
  var re2_1b = /^(.+?)(ed|ing)$/;
  var re_1b_2 = /.$/;
  var re2_1b_2 = /(at|bl|iz)$/;
  var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$");
  var re4_1b_2 = new RegExp("^(" + C + v + "[^aeiouwxy]$");

  var re_1c = /^(.+?[^aeiou])y$/;
  var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;

  var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;

  var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
  var re2_4 = /^(.+?)(s|t)(ion)$/;

  var re_5 = /^(.+?)e$/;
  var re_5_1 = /ll$/;
  var re3_5 = new RegExp("^(" + C + v + "[^aeiouwxy]$");

  var porterStemmer = function porterStemmer(w) {
    var   stem,
      suffix,
      firstch,
      re,
      re2,
      re3,
      re4;

    if (w.length < 3) { return w; }

    firstch = w.substr(0,1);
    if (firstch == "y") {
      w = firstch.toUpperCase() + w.substr(1);
    }

    // Step 1a
    re = re_1a
    re2 = re2_1a;

    if (re.test(w)) { w = w.replace(re,"$1$2"); }
    else if (re2.test(w)) { w = w.replace(re2,"$1$2"); }

    // Step 1b
    re = re_1b;
    re2 = re2_1b;
    if (re.test(w)) {
      var fp = re.exec(w);
      re = re_mgr0;
      if (re.test(fp[1])) {
        re = re_1b_2;
        w = w.replace(re,"");
      }
    } else if (re2.test(w)) {
      var fp = re2.exec(w);
      stem = fp[1];
      re2 = re_s_v;
      if (re2.test(stem)) {
        w = stem;
        re2 = re2_1b_2;
        re3 = re3_1b_2;
        re4 = re4_1b_2;
        if (re2.test(w)) {  w = w + "e"; }
        else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); }
        else if (re4.test(w)) { w = w + "e"; }
      }
    }

    // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)
    re = re_1c;
    if (re.test(w)) {
      var fp = re.exec(w);
      stem = fp[1];
      w = stem + "i";
    }

    // Step 2
    re = re_2;
    if (re.test(w)) {
      var fp = re.exec(w);
      stem = fp[1];
      suffix = fp[2];
      re = re_mgr0;
      if (re.test(stem)) {
        w = stem + step2list[suffix];
      }
    }

    // Step 3
    re = re_3;
    if (re.test(w)) {
      var fp = re.exec(w);
      stem = fp[1];
      suffix = fp[2];
      re = re_mgr0;
      if (re.test(stem)) {
        w = stem + step3list[suffix];
      }
    }

    // Step 4
    re = re_4;
    re2 = re2_4;
    if (re.test(w)) {
      var fp = re.exec(w);
      stem = fp[1];
      re = re_mgr1;
      if (re.test(stem)) {
        w = stem;
      }
    } else if (re2.test(w)) {
      var fp = re2.exec(w);
      stem = fp[1] + fp[2];
      re2 = re_mgr1;
      if (re2.test(stem)) {
        w = stem;
      }
    }

    // Step 5
    re = re_5;
    if (re.test(w)) {
      var fp = re.exec(w);
      stem = fp[1];
      re = re_mgr1;
      re2 = re_meq1;
      re3 = re3_5;
      if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {
        w = stem;
      }
    }

    re = re_5_1;
    re2 = re_mgr1;
    if (re.test(w) && re2.test(w)) {
      re = re_1b_2;
      w = w.replace(re,"");
    }

    // and turn initial Y back to y

    if (firstch == "y") {
      w = firstch.toLowerCase() + w.substr(1);
    }
    return w;
  };

  return porterStemmer;
})();
```

--------------------------------

### DocumentStore.prototype.getDoc

Source: http://elasticlunr.com/docs/document_store.js.html

Retrieves a document from the DocumentStore using its reference.

```APIDOC
## elasticlunr.DocumentStore.prototype.getDoc(docRef)

### Description
Retrieves the JSON document from the document store for a given document reference.

### Parameters
#### Path Parameters
- **docRef** (Integer, String) - Required - The key to lookup and retrieve from the document store.

### Return
- **Object** - The JSON document if found and stored, otherwise null.

### Note
Returns null if the `docRef` is not found or if the DocumentStore is not configured to store original documents.
```
Tokens:
Raw