exists

Checks if the given index exists.


Copied to clipboard!
exists(index, [options]);

Arguments Type Description
index
string
Index name
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 a |

boolean
that indicate whether the index exists or not.

Usage

Copied to clipboard!
try {
  const exists = await kuzzle.index.exists('nyc-open-data');

  if (exists === true) {
    console.log('Index exists');
  } else {
    console.log('Index does not exists');
  }
} catch (error) {
  console.error(error.message);
}