SDK
SDK Javascript v7.x
2

delete #

Deletes a collection.


delete(index, collection);

ArgumentsTypeDescription
index
string
Index name
collection
string
Collection name
options
object
Query options

Options #

Additional query options

OptionsType
(default)
Description
queuable
boolean

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

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

(false)
If set to true, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop.
Available since Kuzzle 2.31.0

Resolves #

Resolves if the collection is successfully deleted.

Usage #

Not found: /home/runner/work/documentation/documentation/.repos/sdk-javascript-7/doc/7/controllers/collection/delete/snippets/delete-specifications.js