Module
IdsFilter
IdsFilter ( ids )
Matches documents with the specified id(s).
|
Method Summary
| 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 | name(name) | Sets the filter name. |
Object | toJSON() | Returns the filter object. |
Object | type(type) | Sets the type as a single type or an array of types. If type is a string, it is added to the list of existing types. If type is an array, it is set as the types and overwrites an existing types. This parameter is optional. |
Object | values(val) | Sets the values array or adds a new value. if val is a string, it is added to the list of existing document ids. If val is an array it is set as the document values and replaces any existing values. |
Method Detail
cache
Object cache ( trueFalse )
Enable or disable caching of the filter
|
cacheKey
Object cacheKey ( key )
Sets the cache key.
|
name
Object name ( name )
Sets the filter name.
|
type
Object type ( type )
Sets the type as a single type or an array of types. If type is a
string, it is added to the list of existing types. If type is an
array, it is set as the types and overwrites an existing types. This
parameter is optional.
|
values
Object values ( val )
Sets the values array or adds a new value. if val is a string, it
is added to the list of existing document ids. If val is an
array it is set as the document values and replaces any existing values.
|