API Docs for: 2.2.2
Show:

Delete.Builder Class

Extends ByKeyBase.Builder
Defined in: lib/commands/ts/delete.js:45
Module: TS

A builder for constructing Delete instances.

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

var get = new Delete.Builder()
     .withKey(key)
     .build();

Constructor

Delete.Builder

()

Defined in lib/commands/ts/delete.js:45

Item Index

Methods

Methods

build

() Delete

Defined in lib/commands/ts/delete.js:65

Construct a Delete instance.

Returns:

Delete:

a Delete instance

withCallback

(
  • callback
)
chainable

Inherited from ByKeyBase.Builder: lib/commands/ts/bykeybase.js:87

Set the callback to be executed when the operation completes.

Parameters:

  • callback Function

    The allback to be executed when the operation completes.

    • err String

      An error message. Will be null if no error.

    • response Object

      The response from Riak

withKey

(
  • key
)
chainable

Inherited from ByKeyBase.Builder: lib/commands/ts/bykeybase.js:76

Set the key

Parameters:

  • key Object

    the timeseries key value

withTable

(
  • table
)
chainable

Inherited from ByKeyBase.Builder: lib/commands/ts/bykeybase.js:65

Set the table.

Parameters:

  • table String

    the table in Riak