ejsOrFilter

A container filter that allows Boolean OR composition of filters.

Module

 OrFilter

OrFilter ( filters )
A container Filter that allows Boolean OR composition of filters.

Parameters
filters <Filter | Filter[]> A valid Filter or array of Filters.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectcache(trueFalse)Enable or disable caching of the filter
ObjectcacheKey(key)Sets the cache key.
Objectfilters(fltr)Updates the filters. If passed a single Filter it is added to the existing filters. If passed an array of Filters, they replace all existing Filters.
Objectname(name)Sets the filter name.
ObjecttoJSON()Returns the filter object.

Method Detail

 _type

String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 cache

Object cache ( trueFalse )
Enable or disable caching of the filter

Parameters
trueFalse <Boolean> True to cache the filter, false otherwise.
Returns
returns this so that calls can be chained.

 cacheKey

Object cacheKey ( key )
Sets the cache key.

Parameters
key <String> the cache key as a string.
Returns
returns this so that calls can be chained.

 filters

Object filters ( fltr )
Updates the filters. If passed a single Filter it is added to the existing filters. If passed an array of Filters, they replace all existing Filters.

Parameters
fltr <Filter | Filter[]> A Filter or array of Filters
Returns
returns this so that calls can be chained.

 name

Object name ( name )
Sets the filter name.

Parameters
name <String> A name for the filter.
Returns
returns this so that calls can be chained.

 toJSON

Object toJSON ( )
Returns the filter object.

Returns
filter object

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo