Index Exists | JavaScript API Client V3 (Deprecated)
settings
ACL
index.exists()
About this method
Returns whether an index exists or not.
Algolia lets you instantiate indices with any name, even if they haven’t been previously created. An initialized index is created when you call save objects or set settings on it. This can result in the accidental creation of new indices, or modification of existing ones.
The exists
method returns a boolean that indicates whether an initialized index has been created.
You should be careful when using this method to execute code conditionally. Due to the asynchronous nature of saving objects, the existence of an index may change between the time a condition is met, and when the conditional code executes. Be mindful of the surrounding code, and of any process that may be altering your indices.
Examples
Check if an index exists
1
$index->exists();
Parameters
No parameters for this method.
Response
No response.