elastic.js: Module: PrefixFilter


        PrefixFilter ( fieldName, prefix )

Filters documents that have fields containing terms with a specified prefix.

Parameters: fieldName <String> the field name to be used during matching.
prefix <String> the prefix value.

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(field)`	Returns the field name used to create this object.
`Object`	`name(name)`	Sets the filter name.
`Object`	`prefix(value)`	Sets the prefix to search for.
`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 ( field )

Returns the field name used to create this object.

Parameters: field <String> the field name
Returns: returns this so that calls can be chained. Returns {String}, field name when field is not specified.


        Object name ( name )

Sets the filter name.


        Object prefix ( value )

Sets the prefix to search for.


        Object toJSON ( )

Returns the filter object.