Namespace: Options

Type Definitions

Options.FireFerretOptionsObject

Properties:

Name	Type	Default	Description
mongo	Options.Mongo
redis	Options.Redis
wideMatch	boolean	false	Use the Wide-Match strategy when checking the cache for queries.

Options.MongoObject

Dictates MongoDB driver behavior. Additional Driver documentation can be found here.

Properties:

Name	Type	Default	Description
uri	String		The MongoDB URI.
dbName	String		The name of the MongoDB database to connect to.
collectionName	String	null	The default database collection.
ndJSON	Boolean	false	Stream documents using the ndJSON spec.
encoding	String	"utf-8"	Encoding to use when streaming.

Options.QueryOptionsObject

Properties:

Name	Type	Argument	Default	Description
stream	Boolean	<optional>	false	Format the query response as a stream.
pagination	Object	<optional>	null	Pagination options. Properties Name Type Default Description page Number | String null The page number, starting at 1. size Number | String null The page size, greater than 0.

Example

{ stream: true, pagination: { page: 2, size: 50 } }

Options.RedisObject

Dictates Redis client behavior. Additional Client documentation can be found here.

Properties:

Name	Type	Default	Description
ndJSON	Boolean	false	Stream documents using the ndJSON spec.
connectionTimeout	Number	5000	Timeout in milliseconds when connecting.
count	Number	1000	Default Redis SCAN work amount.
batchSize	Number	1000	Default batch size when using LPUSH.