new QueryKey(dbName, collectionName, query, queryOptions, ns)
key.js, line 19
| Name | Type | Default | Description |
|---|---|---|---|
dbName |
String |
The database to query |
|
collectionName |
String |
The collection to query |
|
query |
Object | {} |
optional
The cursor query object. |
queryOptions |
Object | null |
optional
The query options. |
ns |
String | 'ff' |
optional
The namescape to use for keys. |
Methods
-
baseKey(){String}
key.js, line 44 -
Generates a QueryKey string without query options
Returns:
Type Description String The base key string. -
oneKey(){String}
key.js, line 57 -
Generates a QueryKey string to be used with individual retrievals.
Returns:
Type Description String The one key string. -
queryString(){String}
key.js, line 70 -
Generate a QueryKey string which includes only the query itself.
Returns:
Type Description String The Query string. -
toString(baseKeyOnly){String}
key.js, line 95 -
Generates a QueryKey string.
Name Type Default Description baseKeyOnlyboolean false optional Generate only the base key variant.
Returns:
Type Description String The QueryKey string.