list

Returns the complete list of indexes.


Copied to clipboard!
list([options]);

Arguments Type Description
options
object
Query options

options

Additional query options

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolves

Resolves to an array of index names.

Usage

Copied to clipboard!
try {
  const indexes = await kuzzle.index.list();
  console.log(indexes);
  /*
    [ 'nyc-open-data', 'mtp-open-data' ]
  */

  console.log(`Kuzzle contains ${indexes.length} indexes`);
} catch (error) {
  console.error(error.message);
}