api documentation for elasticlunr (v0.9.5)

Lightweight full-text search engine in Javascript for browser search and offline search.

table of contents

  1. module elasticlunr
    1. function elasticlunr (config)
    2. function elasticlunr.Configuration (config, fields)
    3. function elasticlunr.DocumentStore (save)
    4. function elasticlunr.EventEmitter ()
    5. function elasticlunr.Index ()
    6. function elasticlunr.InvertedIndex ()
    7. function elasticlunr.Pipeline ()
    8. function elasticlunr.SortedSet ()
    9. function elasticlunr.addStopWords (words)
    10. function elasticlunr.clearStopWords ()
    11. function elasticlunr.resetStopWords ()
    12. function elasticlunr.stemmer (w)
    13. function elasticlunr.stopWordFilter (token)
    14. function elasticlunr.tokenizer (str)
    15. function elasticlunr.trimmer (token)
    16. object elasticlunr.Configuration.prototype
    17. object elasticlunr.DocumentStore.prototype
    18. object elasticlunr.EventEmitter.prototype
    19. object elasticlunr.Index.prototype
    20. object elasticlunr.InvertedIndex.prototype
    21. object elasticlunr.Pipeline.prototype
    22. object elasticlunr.Pipeline.registeredFunctions
    23. object elasticlunr.SortedSet.prototype
    24. object elasticlunr.defaultStopWords
    25. object elasticlunr.utils
    26. string elasticlunr.version
  2. module elasticlunr.Configuration
    1. function elasticlunr.Configuration (config, fields)
  3. module elasticlunr.Configuration.prototype
    1. function elasticlunr.Configuration.prototype.addAllFields2UserConfig (bool, expand, fields)
    2. function elasticlunr.Configuration.prototype.buildDefaultConfig (fields)
    3. function elasticlunr.Configuration.prototype.buildUserConfig (config, fields)
    4. function elasticlunr.Configuration.prototype.get ()
    5. function elasticlunr.Configuration.prototype.reset ()
  4. module elasticlunr.DocumentStore
    1. function elasticlunr.DocumentStore (save)
    2. function elasticlunr.DocumentStore.load (serialisedData)
  5. module elasticlunr.DocumentStore.prototype
    1. function elasticlunr.DocumentStore.prototype.addDoc (docRef, doc)
    2. function elasticlunr.DocumentStore.prototype.addFieldLength (docRef, fieldName, length)
    3. function elasticlunr.DocumentStore.prototype.getDoc (docRef)
    4. function elasticlunr.DocumentStore.prototype.getFieldLength (docRef, fieldName)
    5. function elasticlunr.DocumentStore.prototype.hasDoc (docRef)
    6. function elasticlunr.DocumentStore.prototype.isDocStored ()
    7. function elasticlunr.DocumentStore.prototype.removeDoc (docRef)
    8. function elasticlunr.DocumentStore.prototype.toJSON ()
    9. function elasticlunr.DocumentStore.prototype.updateFieldLength (docRef, fieldName, length)
  6. module elasticlunr.EventEmitter
    1. function elasticlunr.EventEmitter ()
  7. module elasticlunr.EventEmitter.prototype
    1. function elasticlunr.EventEmitter.prototype.addListener ()
    2. function elasticlunr.EventEmitter.prototype.emit (name)
    3. function elasticlunr.EventEmitter.prototype.hasHandler (name)
    4. function elasticlunr.EventEmitter.prototype.removeListener (name, fn)
  8. module elasticlunr.Index
    1. function elasticlunr.Index ()
    2. function elasticlunr.Index.load (serialisedData)
  9. module elasticlunr.Index.prototype
    1. function elasticlunr.Index.prototype.addDoc (doc, emitEvent)
    2. function elasticlunr.Index.prototype.addField (fieldName)
    3. function elasticlunr.Index.prototype.coordNorm (scores, docTokens, n)
    4. function elasticlunr.Index.prototype.fieldSearch (queryTokens, fieldName, config)
    5. function elasticlunr.Index.prototype.fieldSearchStats (docTokens, token, docs)
    6. function elasticlunr.Index.prototype.getFields ()
    7. function elasticlunr.Index.prototype.idf (term, field)
    8. function elasticlunr.Index.prototype.mergeScores (accumScores, scores, op)
    9. function elasticlunr.Index.prototype.off (name, fn)
    10. function elasticlunr.Index.prototype.on ()
    11. function elasticlunr.Index.prototype.removeDoc (doc, emitEvent)
    12. function elasticlunr.Index.prototype.removeDocByRef (docRef, emitEvent)
    13. function elasticlunr.Index.prototype.saveDocument (save)
    14. function elasticlunr.Index.prototype.search (query, userConfig)
    15. function elasticlunr.Index.prototype.setRef (refName)
    16. function elasticlunr.Index.prototype.toJSON ()
    17. function elasticlunr.Index.prototype.updateDoc (doc, emitEvent)
    18. function elasticlunr.Index.prototype.use (plugin)
  10. module elasticlunr.InvertedIndex
    1. function elasticlunr.InvertedIndex ()
    2. function elasticlunr.InvertedIndex.load (serialisedData)
  11. module elasticlunr.InvertedIndex.prototype
    1. function elasticlunr.InvertedIndex.prototype.addToken (token, tokenInfo, root)
    2. function elasticlunr.InvertedIndex.prototype.expandToken (token, memo, root)
    3. function elasticlunr.InvertedIndex.prototype.getDocFreq (token)
    4. function elasticlunr.InvertedIndex.prototype.getDocs (token)
    5. function elasticlunr.InvertedIndex.prototype.getNode (token)
    6. function elasticlunr.InvertedIndex.prototype.getTermFrequency (token, docRef)
    7. function elasticlunr.InvertedIndex.prototype.hasToken (token)
    8. function elasticlunr.InvertedIndex.prototype.removeToken (token, ref)
    9. function elasticlunr.InvertedIndex.prototype.toJSON ()
  12. module elasticlunr.Pipeline
    1. function elasticlunr.Pipeline ()
    2. function elasticlunr.Pipeline.getRegisteredFunction (label)
    3. function elasticlunr.Pipeline.load (serialised)
    4. function elasticlunr.Pipeline.registerFunction (fn, label)
    5. function elasticlunr.Pipeline.warnIfFunctionNotRegistered (fn)
    6. object elasticlunr.Pipeline.registeredFunctions
  13. module elasticlunr.Pipeline.prototype
    1. function elasticlunr.Pipeline.prototype.add ()
    2. function elasticlunr.Pipeline.prototype.after (existingFn, newFn)
    3. function elasticlunr.Pipeline.prototype.before (existingFn, newFn)
    4. function elasticlunr.Pipeline.prototype.get ()
    5. function elasticlunr.Pipeline.prototype.remove (fn)
    6. function elasticlunr.Pipeline.prototype.reset ()
    7. function elasticlunr.Pipeline.prototype.run (tokens)
    8. function elasticlunr.Pipeline.prototype.toJSON ()
  14. module elasticlunr.Pipeline.registeredFunctions
    1. function elasticlunr.Pipeline.registeredFunctions.stemmer (w)
    2. function elasticlunr.Pipeline.registeredFunctions.stopWordFilter (token)
    3. function elasticlunr.Pipeline.registeredFunctions.trimmer (token)
  15. module elasticlunr.SortedSet
    1. function elasticlunr.SortedSet ()
    2. function elasticlunr.SortedSet.load (serialisedData)
  16. module elasticlunr.SortedSet.prototype
    1. function elasticlunr.SortedSet.prototype.add ()
    2. function elasticlunr.SortedSet.prototype.clone ()
    3. function elasticlunr.SortedSet.prototype.forEach (fn, ctx)
    4. function elasticlunr.SortedSet.prototype.indexOf (elem)
    5. function elasticlunr.SortedSet.prototype.intersect (otherSet)
    6. function elasticlunr.SortedSet.prototype.locationFor (elem)
    7. function elasticlunr.SortedSet.prototype.map (fn, ctx)
    8. function elasticlunr.SortedSet.prototype.toArray ()
    9. function elasticlunr.SortedSet.prototype.toJSON ()
    10. function elasticlunr.SortedSet.prototype.union (otherSet)
  17. module elasticlunr.tokenizer
    1. function elasticlunr.tokenizer (str)
    2. function elasticlunr.tokenizer.getSeperator ()
    3. function elasticlunr.tokenizer.resetSeperator ()
    4. function elasticlunr.tokenizer.setSeperator (sep)
    5. object elasticlunr.tokenizer.defaultSeperator
    6. object elasticlunr.tokenizer.seperator
  18. module elasticlunr.utils
    1. function elasticlunr.utils.toString (obj)
    2. function elasticlunr.utils.warn (message)

module elasticlunr

function elasticlunr (config)

function elasticlunr.Configuration (config, fields)

function elasticlunr.DocumentStore (save)

function elasticlunr.EventEmitter ()

function elasticlunr.Index ()

function elasticlunr.InvertedIndex ()

function elasticlunr.Pipeline ()

function elasticlunr.SortedSet ()

function elasticlunr.addStopWords (words)

function elasticlunr.clearStopWords ()

function elasticlunr.resetStopWords ()

function elasticlunr.stemmer (w)

function elasticlunr.stopWordFilter (token)

function elasticlunr.tokenizer (str)

function elasticlunr.trimmer (token)

module elasticlunr.Configuration

function elasticlunr.Configuration (config, fields)

module elasticlunr.Configuration.prototype

function elasticlunr.Configuration.prototype.addAllFields2UserConfig (bool, expand, fields)

function elasticlunr.Configuration.prototype.buildDefaultConfig (fields)

function elasticlunr.Configuration.prototype.buildUserConfig (config, fields)

function elasticlunr.Configuration.prototype.get ()

function elasticlunr.Configuration.prototype.reset ()

module elasticlunr.DocumentStore

function elasticlunr.DocumentStore (save)

function elasticlunr.DocumentStore.load (serialisedData)

module elasticlunr.DocumentStore.prototype

function elasticlunr.DocumentStore.prototype.addDoc (docRef, doc)

function elasticlunr.DocumentStore.prototype.addFieldLength (docRef, fieldName, length)

function elasticlunr.DocumentStore.prototype.getDoc (docRef)

function elasticlunr.DocumentStore.prototype.getFieldLength (docRef, fieldName)

function elasticlunr.DocumentStore.prototype.hasDoc (docRef)

function elasticlunr.DocumentStore.prototype.isDocStored ()

function elasticlunr.DocumentStore.prototype.removeDoc (docRef)

function elasticlunr.DocumentStore.prototype.toJSON ()

function elasticlunr.DocumentStore.prototype.updateFieldLength (docRef, fieldName, length)

module elasticlunr.EventEmitter

function elasticlunr.EventEmitter ()

module elasticlunr.EventEmitter.prototype

function elasticlunr.EventEmitter.prototype.addListener ()

function elasticlunr.EventEmitter.prototype.emit (name)

function elasticlunr.EventEmitter.prototype.hasHandler (name)

function elasticlunr.EventEmitter.prototype.removeListener (name, fn)

module elasticlunr.Index

function elasticlunr.Index ()

function elasticlunr.Index.load (serialisedData)

module elasticlunr.Index.prototype

function elasticlunr.Index.prototype.addDoc (doc, emitEvent)

function elasticlunr.Index.prototype.addField (fieldName)

function elasticlunr.Index.prototype.coordNorm (scores, docTokens, n)

function elasticlunr.Index.prototype.fieldSearch (queryTokens, fieldName, config)

function elasticlunr.Index.prototype.fieldSearchStats (docTokens, token, docs)

function elasticlunr.Index.prototype.getFields ()

function elasticlunr.Index.prototype.idf (term, field)

function elasticlunr.Index.prototype.mergeScores (accumScores, scores, op)

function elasticlunr.Index.prototype.off (name, fn)

function elasticlunr.Index.prototype.on ()

function elasticlunr.Index.prototype.removeDoc (doc, emitEvent)

function elasticlunr.Index.prototype.removeDocByRef (docRef, emitEvent)

function elasticlunr.Index.prototype.saveDocument (save)

function elasticlunr.Index.prototype.search (query, userConfig)

function elasticlunr.Index.prototype.setRef (refName)

function elasticlunr.Index.prototype.toJSON ()

function elasticlunr.Index.prototype.updateDoc (doc, emitEvent)

function elasticlunr.Index.prototype.use (plugin)

module elasticlunr.InvertedIndex

function elasticlunr.InvertedIndex ()

function elasticlunr.InvertedIndex.load (serialisedData)

module elasticlunr.InvertedIndex.prototype

function elasticlunr.InvertedIndex.prototype.addToken (token, tokenInfo, root)

function elasticlunr.InvertedIndex.prototype.expandToken (token, memo, root)

function elasticlunr.InvertedIndex.prototype.getDocFreq (token)

function elasticlunr.InvertedIndex.prototype.getDocs (token)

function elasticlunr.InvertedIndex.prototype.getNode (token)

function elasticlunr.InvertedIndex.prototype.getTermFrequency (token, docRef)

function elasticlunr.InvertedIndex.prototype.hasToken (token)

function elasticlunr.InvertedIndex.prototype.removeToken (token, ref)

function elasticlunr.InvertedIndex.prototype.toJSON ()

module elasticlunr.Pipeline

function elasticlunr.Pipeline ()

function elasticlunr.Pipeline.getRegisteredFunction (label)

function elasticlunr.Pipeline.load (serialised)

function elasticlunr.Pipeline.registerFunction (fn, label)

function elasticlunr.Pipeline.warnIfFunctionNotRegistered (fn)

module elasticlunr.Pipeline.prototype

function elasticlunr.Pipeline.prototype.add ()

function elasticlunr.Pipeline.prototype.after (existingFn, newFn)

function elasticlunr.Pipeline.prototype.before (existingFn, newFn)

function elasticlunr.Pipeline.prototype.get ()

function elasticlunr.Pipeline.prototype.remove (fn)

function elasticlunr.Pipeline.prototype.reset ()

function elasticlunr.Pipeline.prototype.run (tokens)

function elasticlunr.Pipeline.prototype.toJSON ()

module elasticlunr.Pipeline.registeredFunctions

function elasticlunr.Pipeline.registeredFunctions.stemmer (w)

function elasticlunr.Pipeline.registeredFunctions.stopWordFilter (token)

function elasticlunr.Pipeline.registeredFunctions.trimmer (token)

module elasticlunr.SortedSet

function elasticlunr.SortedSet ()

function elasticlunr.SortedSet.load (serialisedData)

module elasticlunr.SortedSet.prototype

function elasticlunr.SortedSet.prototype.add ()

function elasticlunr.SortedSet.prototype.clone ()

function elasticlunr.SortedSet.prototype.forEach (fn, ctx)

function elasticlunr.SortedSet.prototype.indexOf (elem)

function elasticlunr.SortedSet.prototype.intersect (otherSet)

function elasticlunr.SortedSet.prototype.locationFor (elem)

function elasticlunr.SortedSet.prototype.map (fn, ctx)

function elasticlunr.SortedSet.prototype.toArray ()

function elasticlunr.SortedSet.prototype.toJSON ()

function elasticlunr.SortedSet.prototype.union (otherSet)

module elasticlunr.tokenizer

function elasticlunr.tokenizer (str)

function elasticlunr.tokenizer.getSeperator ()

function elasticlunr.tokenizer.resetSeperator ()

function elasticlunr.tokenizer.setSeperator (sep)

module elasticlunr.utils

function elasticlunr.utils.toString (obj)

function elasticlunr.utils.warn (message)

[ this document was created with utility2 ]