Options
All
  • Public
  • Public/Protected
  • All
Menu

@lokidb/lokidb-src

Index

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

CharacterFilter

CharacterFilter: function

A character filter is used to preprocess a string before it is passed to a tokenizer.

Type declaration

    • (value: string): string

    • Parameters

      • value: string

      Returns string

CloneMethod

CloneMethod: "parse-stringify" | "deep" | "shallow" | "shallow-recurse"

Doc

Doc: T & object

QueryTypes

QueryTypes: BoolQuery | ConstantScoreQuery | TermQuery | TermsQuery | WildcardQuery | FuzzyQuery | MatchQuery | MatchQueryAll | PrefixQuery | ExistsQuery

Union type of possible query types.

RangedValueOperator

RangedValueOperator: "$gt" | "$gte" | "$lt" | "$lte" | "$eq" | "$neq" | "$between"

TokenFilter

TokenFilter: function

A token filter takes tokens from a tokenizer and modify, delete or add tokens.

Type declaration

    • (value: string, index: number, array: string[]): string

    • Parameters

      • value: string
      • index: number
      • array: string[]

      Returns string

Tokenizer

Tokenizer: function

A tokenizer splits a string into individual tokens.

Type declaration

    • (value: string): string[]

    • Parameters

      • value: string

      Returns string[]

TreeNode

TreeNode: object

Treenode type for binary search tree (BST) implementation.

To support duplicates, we may need to either repurpose parent to point to 'elder' sibling or add a siblingId to point to owner of node represented in tree.

Type declaration

Functions

CreateAbstractDateJavascriptComparator

  • Comparator which attempts to deal with deal with dates at comparator level. Should work for dates in any of the object, string, and number formats

    Type parameters

    • T

    Returns ILokiComparer<T>

CreateAbstractJavascriptComparator

CreateJavascriptComparator

CreateLokiComparator

analyze

  • analyze(analyzer: Analyzer, str: string): string[]

generateStopWordFilter

  • generateStopWordFilter(stopWords: string[]): (Anonymous function)

generateTrimmer

  • generateTrimmer(wordCharacters: string): (Anonymous function)

lowercaseTokenFilter

  • lowercaseTokenFilter(token: string): string

uppercaseTokenFilter

  • uppercaseTokenFilter(token: string): string

whitespaceTokenizer

  • whitespaceTokenizer(value: string): string[]

Object literals

Let ComparatorMap

ComparatorMap: object

Map/Register of named ILokiComparer functions returning -1, 0, 1 for lt/eq/gt assertions for two passed parameters

abstract-date

abstract-date: ILokiComparer<any> = CreateAbstractDateJavascriptComparator<any>()

abstract-js

abstract-js: ILokiComparer<any> = CreateAbstractJavascriptComparator<any>()

js

js: ILokiComparer<any> = CreateJavascriptComparator<any>()

loki

loki: ILokiComparer<any> = CreateLokiComparator()

Let LokiOperatorPackageMap

LokiOperatorPackageMap: object

Map/Register of named LokiOperatorPackages which implement all unindexed query ops within 'find' query objects

js

js: LokiOperatorPackage = new LokiOperatorPackage()

loki

loki: LokiAbstractOperatorPackage = new LokiAbstractOperatorPackage()

Let RangedIndexFactoryMap

RangedIndexFactoryMap: object

Map/Register of named factory functions returning IRangedIndex instances

avl

Generated using TypeDoc