Collection.uniqueKeys()

Syntax

collection.uniqueKeys(callback)

Parameters

callback: Function

function (keysArray) { }

optional

Callback Parameters

keysArray: Array

Array of unique keys

Return Value

Promise

Description

Retrieves an array of all unique indexes in the collection.

Sample

db.friends.orderBy('firstName').uniqueKeys(function (keysArray) {
    // keysArray is now all firstNames without duplicates even if having multiple
    // friends with same name.
});

// Not possible to use keys(), uniqueKeys(), eachKey() or eachUniqueKey() when
// Collection instance is based on the primary key:
db.friends.orderBy(':id').uniqueKeys() // Will fail!

Remarks

If callback is omitted and operation succeeds, returned Promise will resolve with the result of the operation, calling any Promise.then() callback.

If callback is specified and operation succeeds, given callback will be called and the returned Promise will resolve with the return value of given callback.

If operation fails, returned promise will reject, calling any Promise.catch() callback.