elastic.js: Module: TermFilter


        TermFilter ( fieldName, term )

Constructs a filter for docs matching the term added to this object.

Parameters: fieldName <string> The document field/fieldName to execute the filter against.
term <string> The literal term used to filter the results.

Returns	Name	Description
`String`	`_type()`	The type of ejs object. For internal use only.
`Object`	`cache(trueFalse)`	Enable or disable caching of the filter
`Object`	`cacheKey(key)`	Sets the cache key.
`Object`	`field(f)`	Provides access to the filter fieldName used to construct the termFilter object.
`Object`	`name(name)`	Sets the filter name.
`Object`	`term()`	Provides access to the filter term used to construct the termFilter object.
`Object`	`toJSON()`	Returns the filter object.


        String _type ( )

The type of ejs object. For internal use only.


        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.


        Object cacheKey ( key )

Sets the cache key.


        Object field ( f )

Provides access to the filter fieldName used to construct the termFilter object.

Parameters: f <String> the fieldName term
Returns: returns this so that calls can be chained. When k is not specified, Returns {String}, the filter fieldName used to construct the termFilter object.


        Object name ( name )

Sets the filter name.


        Object term ( )

Provides access to the filter term used to construct the termFilter object.

Returns: returns this so that calls can be chained. When k is not specified, Returns {String}, the filter term used to construct the termFilter object.


        Object toJSON ( )

Returns the filter object.