lunr library

Classes

Builder
Builder performs indexing on a set of documents and returns instances of Index ready for querying.
BuilderFrame
Clause
DocMatch
FieldRef
Frame
Index
An index contains the built index of all documents and provides a query interface to the index.
InvertedIndex
Lexeme
Lunr
Wrapper for conveniance function, init and version
MatchData
Contains and collects metadata about a matching document. A list of MatchData is returned as part of every search.
Pipeline
Posting
Query
QueryLexer
Set
Token
TokenSet
TokenSetBuilder
Utils
Vector

Properties

c ↔ String
getter/setter pair
C ↔ String
getter/setter pair
lunr ↔ Index Function(BuilderCallback )
A convenience function for configuring and constructing a new lunr Index.
getter/setter pair
meq1 ↔ String
getter/setter pair
mgr0 ↔ String
getter/setter pair
mgr1 ↔ String
getter/setter pair
re2_1a ↔ RegExp
getter/setter pair
re2_1b ↔ RegExp
getter/setter pair
re2_1b_2 ↔ RegExp
getter/setter pair
re2_4 ↔ RegExp
getter/setter pair
re3_1b_2 ↔ RegExp
getter/setter pair
re3_5 ↔ RegExp
getter/setter pair
re4_1b_2 ↔ RegExp
getter/setter pair
re_1a ↔ RegExp
getter/setter pair
re_1b ↔ RegExp
getter/setter pair
re_1b_2 ↔ RegExp
getter/setter pair
re_1c ↔ RegExp
getter/setter pair
re_2 ↔ RegExp
getter/setter pair
re_3 ↔ RegExp
getter/setter pair
re_4 ↔ RegExp
getter/setter pair
re_5 ↔ RegExp
getter/setter pair
re_5_1 ↔ RegExp
getter/setter pair
re_meq1 ↔ RegExp
getter/setter pair
re_mgr0 ↔ RegExp
getter/setter pair
re_mgr1 ↔ RegExp
getter/setter pair
re_s_v ↔ RegExp
getter/setter pair
s_v ↔ String
getter/setter pair
separator → RegExp
final
step2list ↔ Map<String, String>
getter/setter pair
step3list ↔ Map<String, String>
getter/setter pair
stopWordFilter ↔ PipelineFunction
getter/setter pair
v ↔ String
getter/setter pair
V ↔ String
getter/setter pair

Functions

generateStopWordFilter(List<String> stopWords) → PipelineFunction
idf(Posting posting, int documentCount) → double
A function to calculate the inverse document frequency for a posting. This is shared between the builder and the index
stemmer(Token? token, int i, List<Token?> tokens) → Token?
tokenizer([dynamic obj, TokenMetaData? metadata]) → List<Token>
trimmer(Token? token, int i, List<Token?> tokens) → Token?

Typedefs

BuilderCallback = dynamic Function(Builder)
BuilderStack = List<BuilderFrame>
ExtractorCallback = String Function(Map<String, dynamic> lookup)
FieldMap = Map<String, Metadata>
FieldMapping = Map<String, dynamic>
FieldTermFrequencies = Map<FieldRef, TermFrequencies>
Metadata = Map<String, dynamic>
PipelineFunction = dynamic Function(Token? token, int i, List<Token?> tokens)
QueryCallback = dynamic Function(Query query)
Stack = List<Frame>
TermFrequencies = Map<Token, int>
TermMap = Map<String, FieldMap>
Tokenizer = List<Token> Function([dynamic obj, Map<String, dynamic>? metadata])
TokenMetaData = Metadata
TokenUpdateFn = String Function(String, TokenMetaData? metadata)
UpsertFn = num Function(num, num)

Exceptions / Errors

QueryParseError