Focus

flitter-orm/src/filter/Focus~ Focus

A filter, focused on a particular field.


Constructor

new Focus()

Members

(private) _field :string

The field to focus on.

Type:
  • string

(private) _notting :boolean

Are we notting right now? Default false.

Type:
  • boolean

(private) _parent :module:flitter-orm/src/filter/Filter~Filter

The parent filter.

(private) _root :object

The root filter.

Type:
  • object

Methods

end() → {module:flitter-orm/src/filter/Filter~Filter|module:flitter-orm/src/filter/Focus~Focus}

If notting, end notting mode. Otherwise, unfocus back to the parent filter.

equal(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be equal to the value. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

greater_than(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be greater than the value. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

greater_than_equal(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be greater than or equal to the value. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

in(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be in an array of possible values. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

less_than(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be less than the value. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

less_than_equal(value) → {module:flitter-orm/src/filter/Focus~Focus}

Assert that the field must be less than or equal to the value. (Or if were in notting mode, the opposite.)

Parameters:
Name Type Description
value *

not() → {module:flitter-orm/src/filter/Focus~Focus}

Enable notting mode.