RangeBuilder | etcd3

RangeBuilder is a primitive builder for range queries on the kv store. It's extended by the Single and MultiRangeBuilders, which contain the concrete methods to execute the built query.

Type parameters

T

Hierarchy

PromiseWrap<T>
- RangeBuilder
  - SingleRangeBuilder
  - MultiRangeBuilder

Implements

PromiseLike<T>
IOperation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RangeBuilder(namespace: NSApplicator): RangeBuilder

- Defined in src/builder.ts:62
Parameters
- namespace: NSApplicator
Returns RangeBuilder

Properties

Protected callOptions

callOptions: CallOptions | undefined

Protected Readonly namespace

namespace: NSApplicator

Protected request

request: IRangeRequest

Methods

catch

catch<R>(onRejected: (err: any) => R | Promise<R>): Promise<T | R>

Inherited from PromiseWrap.catch
- Defined in src/util.ts:234
catch implements Promiselike.catch()

Type parameters
- R
Parameters
- onRejected: (err: any) => R | Promise<R>
  - - (err: any): R | Promise<R>
    - Parameters
      - err: any
      Returns R | Promise<R>
Returns Promise<T | R>

Protected Abstract createPromise

createPromise(): Promise<T>

Inherited from PromiseWrap.createPromise
- Defined in src/util.ts:241
createPromise should ben override to run the promised action.

Returns Promise<T>

maxCreateRevision

maxCreateRevision(maxCreateRevision: number | string): this

- Defined in src/builder.ts:111
maxCreateRevision sets the maximum create revision of keys to return.

Parameters
- maxCreateRevision: number | string
Returns this

maxModRevision

maxModRevision(maxModRevision: number | string): this

- Defined in src/builder.ts:95
maxModRevision sets the maximum modified revision of keys to return.

Parameters
- maxModRevision: number | string
Returns this

minCreateRevision

minCreateRevision(minCreateRevision: number | string): this

- Defined in src/builder.ts:103
minCreateRevision sets the minimum create revision of keys to return.

Parameters
- minCreateRevision: number | string
Returns this

minModRevision

minModRevision(minModRevision: number | string): this

- Defined in src/builder.ts:87
minModRevision sets the minimum modified revision of keys to return.

Parameters
- minModRevision: number | string
Returns this

op

op(): Promise<IRequestOp>

Implementation of IOperation.op
- Defined in src/builder.ts:127
Returns the request op for this builder, used in transactions.

Returns Promise<IRequestOp>

options

options(options: CallOptions | undefined): this

- Defined in src/builder.ts:119
Sets the GRPC call options for this request.

Parameters
- options: CallOptions | undefined
Returns this

revision

revision(rev: number | string): this

- Defined in src/builder.ts:71
revision is the point-in-time of the key-value store to use for the range.

Parameters
- rev: number | string
Returns this

serializable

serializable(serializable: boolean): this

- Defined in src/builder.ts:79
serializable sets the range request to use serializable member-local reads.

Parameters
- serializable: boolean
Returns this

then

then<R, V>(onFulfilled: (value: T) => R | Promise<R>, onRejected?: undefined | ((err: any) => V | Promise<V>)): Promise<R | V>

Inherited from PromiseWrap.then
- Defined in src/util.ts:224
then implements Promiselike.then()

Type parameters
- R
- V
Parameters
- onFulfilled: (value: T) => R | Promise<R>
  - - (value: T): R | Promise<R>
    - Parameters
      - value: T
      Returns R | Promise<R>
- Optional onRejected: undefined | ((err: any) => V | Promise<V>)
Returns Promise<R | V>

Generated using TypeDoc