API Docs for: 2.2.2
Show:

DeleteIndex.Builder Class

Defined in: lib/commands/yokozuna/deleteindex.js:63
Module: YZ

A builder for constructing DeleteIndex instances.

Rather than having to manually construct the options and instantiating a DeleteIndex directly, this builder may be used.

var del = DeleteIndex.Builder()
             .withIndexName('index_name')
             .withCallback(callback)
             .build();

Constructor

DeleteIndex.Builder

()

Defined in lib/commands/yokozuna/deleteindex.js:63

Item Index

Methods

Methods

build

() DeleteIndex

Defined in lib/commands/yokozuna/deleteindex.js:104

Construct a DeleteIndex instance.

Returns:

DeleteIndex:

withCallback

(
  • callback
)
chainable

Defined in lib/commands/yokozuna/deleteindex.js:92

Set the callback to be executed when the operation completes.

Parameters:

  • callback Function

    the callback to execute

    • err String

      An error message

    • response Boolean

      will always be true.

withIndexName

(
  • indexName
)
chainable

Defined in lib/commands/yokozuna/deleteindex.js:81

The name of the index to delete. If one is not supplied, all indexes are returned.

Parameters:

  • indexName String

    the name of the index