API Docs for: 2.2.2
Show:

Describe.Builder Class

Defined in: lib/commands/ts/describe.js:60
Module: TS

A builder for constructing Describe instances.

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

var storeValue = new Describe.Builder()
     .withTable('table')
     .build();

Constructor

Describe.Builder

()

Defined in lib/commands/ts/describe.js:60

Item Index

Methods

Methods

build

() Describe

Defined in lib/commands/ts/describe.js:98

Construct a Describe instance.

Returns:

Describe:

a Describe instance

withCallback

(
  • callback
)
chainable

Defined in lib/commands/ts/describe.js:86

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

withDescribe

(
  • table
)
chainable

Defined in lib/commands/ts/describe.js:76

Set the timeseries table.

Parameters:

  • table String

    the timeseries table