api.md

Classes

SearchFactory

SearchFactory Class

SearchInterpreter

SearchInterpreter

SearchNormalizer

SearchParser

SearchParser

SearchTokenizer

SearchTokenizer

Search

Search

SearchFactory

SearchFactory Class

Kind: global class

• SearchFactory
  • new SearchFactory(registry)
  • .createTokenizer() ⇒ SearchTokenizer
  • .createParser() ⇒ SearchParser
  • .createInterpreter() ⇒ SearchInterpreter

new SearchFactory(registry)

Param	Type	Description
registry	Object	The registry for storing class references

searchFactory.createTokenizer() ⇒ SearchTokenizer

Creates an instance of the SearchTokenizer class

Kind: instance method of SearchFactory
Returns: SearchTokenizer - - Instance of SearchTokenizer

searchFactory.createParser() ⇒ SearchParser

Creates an instance of the SearchParser class

Kind: instance method of SearchFactory
Returns: SearchParser - - Instance of SearchParser

searchFactory.createInterpreter() ⇒ SearchInterpreter

Creates an instance of the SearchInterpreter class

Kind: instance method of SearchFactory
Returns: SearchInterpreter - - Instance of SearchInterpreter

SearchInterpreter

Kind: global class

• SearchInterpreter
  • new SearchInterpreter(ast)
  • .interpret(text) ⇒ boolean

new SearchInterpreter(ast)

Param	Type	Description
ast	Object	The AST to interpret

searchInterpreter.interpret(text) ⇒ boolean

Interprets the AST against a given text

Kind: instance method of SearchInterpreter

Param	Type	Description
text	string	Text to search

SearchInterpreter

Kind: global class

• SearchInterpreter
  • new SearchInterpreter(ast)
  • .interpret(text) ⇒ boolean

new SearchInterpreter(ast)

Param	Type	Description
ast	Object	The AST to interpret

searchInterpreter.interpret(text) ⇒ boolean

Interprets the AST against a given text

Kind: instance method of SearchInterpreter

Param	Type	Description
text	string	Text to search

SearchNormalizer

Kind: global class

SearchNormalizer.normalize(text) ⇒ string

Normalizes a text string

Kind: static method of SearchNormalizer

Param	Type	Description
text	string	Text to normalize

SearchParser

Kind: global class

• SearchParser
  • new SearchParser(tokens)
  • .parse() ⇒ Object

new SearchParser(tokens)

Param	Type	Description
tokens	Array	Tokens to parse

searchParser.parse() ⇒ Object

Initiates the parsing process

Kind: instance method of SearchParser
Returns: Object - - AST

SearchParser

Kind: global class

• SearchParser
  • new SearchParser(tokens)
  • .parse() ⇒ Object

new SearchParser(tokens)

Param	Type	Description
tokens	Array	Tokens to parse

searchParser.parse() ⇒ Object

Initiates the parsing process

Kind: instance method of SearchParser
Returns: Object - - AST

SearchTokenizer

Kind: global class

searchTokenizer.tokenize(query) ⇒ Array

Tokenizes a query string

Kind: instance method of SearchTokenizer
Returns: Array - - List of tokens

Param	Type	Description
query	string	Query to tokenize

SearchTokenizer

Kind: global class

searchTokenizer.tokenize(query) ⇒ Array

Tokenizes a query string

Kind: instance method of SearchTokenizer
Returns: Array - - List of tokens

Param	Type	Description
query	string	Query to tokenize

Search

Kind: global class

• Search
  • new Search(opts)
  • .evaluator(needle) ⇒ function
  • .evaluate(needle, haystack) ⇒ boolean

new Search(opts)

Param	Type	Description
opts	Object	Options for Search

search.evaluator(needle) ⇒ function

Creates an evaluator function based on the needle (query string)

Kind: instance method of Search
Returns: function - - Evaluator function

Param	Type	Description
needle	string	Query string

search.evaluate(needle, haystack) ⇒ boolean

Evaluates a query string against a text string

Kind: instance method of Search
Returns: boolean - - True if the query matches, false otherwise

Param	Type	Description
needle	string	Query string
haystack	string	Text string

Search

Kind: global class

• Search
  • new Search(opts)
  • .evaluator(needle) ⇒ function
  • .evaluate(needle, haystack) ⇒ boolean

new Search(opts)

Param	Type	Description
opts	Object	Options for Search

search.evaluator(needle) ⇒ function

Creates an evaluator function based on the needle (query string)

Kind: instance method of Search
Returns: function - - Evaluator function

Param	Type	Description
needle	string	Query string

search.evaluate(needle, haystack) ⇒ boolean

Evaluates a query string against a text string

Kind: instance method of Search
Returns: boolean - - True if the query matches, false otherwise

Param	Type	Description
needle	string	Query string
haystack	string	Text string