Class HFilterBuilder

constructor

• new HFilterBuilder(): HFilterBuilder

• Returns HFilterBuilder

Readonly _isHFilterBuilder

internalBuffer

• get internalBuffer(): string

• The internal buffer used to build the haystack filter.

  Please note, this method is only intended for debugging/testing purposes.

  Returns string

and

• and(): HFilterBuilder

• Adds an and statement.

  Returns HFilterBuilder

  The builder instance.

build

• build(): string

• Validate and build the haystack filter.

  Returns string

  The haystack filter.

  Throws

  An error if the haystack filter is invalid.

endParens

• endParens(): HFilterBuilder

• Adds an ending parenthesis )

  Returns HFilterBuilder

  The builder instance.

equals

• equals(path, value): HFilterBuilder

• Add a value equals comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

filter

• filter(filter): HFilterBuilder

• Write the filter into this filter.

  Parameters

  • filter: string | Node | HFilter | HFilterBuilder

    The filter value to write.

  Returns HFilterBuilder

  The builder instance.

greaterThan

• greaterThan(path, value): HFilterBuilder

• Add a value greater than comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

greaterThanEquals

• greaterThanEquals(path, value): HFilterBuilder

• Add a value greater than or equal to comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

has

• has(path): HFilterBuilder

• Adds a does the tag exist condition.

  Parameters

  • path: Path

    The path.

  Returns HFilterBuilder

  The builder instance.

inspect

• inspect(): HFilterBuilder

• Dump the current state of the filter builder to the console output.

  Returns HFilterBuilder

  The builder instance.

is

• is(name): HFilterBuilder

• Adds an 'is a' statement.

  Parameters

  • name: string | HSymbol

    The symbol name to use in the query.

  Returns HFilterBuilder

  The builder instance.

isEmpty

• isEmpty(): boolean

• Return true if nothing has been written to the builder.

  Returns boolean

  True if the internal buffer is empty.

lessThan

• lessThan(path, value): HFilterBuilder

• Add a value less than comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

lessThanEquals

• lessThanEquals(path, value): HFilterBuilder

• Add a value less than or equal to comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

not

• not(path): HFilterBuilder

• Adds a not statement.

  Parameters

  • path: Path

    The path to add.

  Returns HFilterBuilder

  The builder instance.

notEquals

• notEquals(path, value): HFilterBuilder

• Add a value not equals comparison.

  Parameters

  • path: Path

    The path to add.

  • value: Value

    The value.

  Returns HFilterBuilder

  The builder instance.

or

• or(): HFilterBuilder

• Adds an or statement.

  Returns HFilterBuilder

  The builder instance.

relationship

• relationship(name, term?, ref?): HFilterBuilder

• Add a relationship query.

  Parameters

  • name: string | HSymbol

    The name of the relationship to query.

  • Optional term: string | HSymbol

    Optional relationship's term. An empty string can be used to skip this parameter.

  • Optional ref: string | HRef

    Optional target reference value.

  Returns HFilterBuilder

  The builder instance.

startParens

• startParens(): HFilterBuilder

• Adds a starting parenthesis (

  Returns HFilterBuilder

  The builder instance.

Static isHFilterBuilder

• isHFilterBuilder(value): value is HFilterBuilder

• Return true if the value is a haystack filter builder object.

  Parameters

  • value: unknown

    The value to test.

  Returns value is HFilterBuilder

  True if the value is a haystack filter builder.