SDK
SDK Javascript v7.x
2

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
timeout
number

Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely

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);
}