MultiRangeBuilder | etcd3

MultiRangeBuilder is a query builder that looks up multiple keys.

Hierarchy

RangeBuilder<{}>
- MultiRangeBuilder

Implements

PromiseLike<{}>
IOperation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MultiRangeBuilder(kv: KVClient, namespace: NSApplicator): MultiRangeBuilder

Overrides RangeBuilder.constructor
- Defined in src/builder.ts:202
Parameters
- kv: KVClient
- namespace: NSApplicator
Returns MultiRangeBuilder

Properties

Protected callOptions

callOptions: CallOptions | undefined

Protected Readonly namespace

namespace: NSApplicator

Protected request

request: IRangeRequest

Methods

all

all(): this

- Defined in src/builder.ts:229
All will instruct etcd to get all keys.

Returns this

buffers

buffers(): Promise<{}>

- Defined in src/builder.ts:307
Runs the built request and returns the value of the returned key as a buffers.

Returns Promise<{}>

catch

catch<R>(onRejected: (err: any) => R | Promise<R>): Promise<{} | 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<{} | R>

count

count(): Promise<number>

- Defined in src/builder.ts:255
count returns the number of keys that match the query.

Returns Promise<number>

Protected createPromise

createPromise(): Promise<{}>

Overrides PromiseWrap.createPromise
- Defined in src/builder.ts:329
override

Returns Promise<{}>

exec

exec(): Promise<IRangeResponse>

- Defined in src/builder.ts:314
Runs the built request and returns the raw response from etcd.

Returns Promise<IRangeResponse>

inRange

inRange(r: Rangable): this

- Defined in src/builder.ts:219
inRange instructs the builder to get keys in the specified byte range.

Parameters
- r: Rangable
Returns this

json

json(): Promise<{}>

- Defined in src/builder.ts:283
Runs the built request and parses the returned keys as JSON.

Returns Promise<{}>

keyBuffers

keyBuffers(): Promise<Buffer[]>

- Defined in src/builder.ts:273
Keys returns an array of keys matching the query, as buffers.

Returns Promise<Buffer[]>

keys

keys(encoding?: BufferEncoding): Promise<string[]>

- Defined in src/builder.ts:263
Keys returns an array of keys matching the query.

Parameters
- Default value encoding: BufferEncoding = "utf8"
Returns Promise<string[]>

limit

limit(count: number): this

- Defined in src/builder.ts:236
Limit sets the maximum number of results to retrieve.

Parameters
- count: number
Returns this

maxCreateRevision

maxCreateRevision(maxCreateRevision: number | string): this

Inherited from RangeBuilder.maxCreateRevision
- 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

Inherited from RangeBuilder.maxModRevision
- 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

Inherited from RangeBuilder.minCreateRevision
- 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

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

Parameters
- minModRevision: number | string
Returns this

numbers

numbers(): Promise<{}>

- Defined in src/builder.ts:299
Runs the built request and returns the values of keys as numbers. May resolve to NaN if the keys do not contain numbers.

Returns Promise<{}>

op

op(): Promise<IRequestOp>

Implementation of IOperation.op

Inherited from RangeBuilder.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

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

Parameters
- options: CallOptions | undefined
Returns this

prefix

prefix(value: string | Buffer): this

- Defined in src/builder.ts:212
Prefix instructs the query to scan for all keys that have the provided prefix.

Parameters
- value: string | Buffer
Returns this

revision

revision(rev: number | string): this

Inherited from RangeBuilder.revision
- 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

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

Parameters
- serializable: boolean
Returns this

sort

sort(target: keyof typeof SortTarget, order: keyof typeof SortOrder): this

- Defined in src/builder.ts:244
Sort specifies how the result should be sorted.

Parameters
- target: keyof typeof SortTarget
- order: keyof typeof SortOrder
Returns this

strings

strings(encoding?: BufferEncoding): Promise<{}>

- Defined in src/builder.ts:291
Runs the built request and returns the value of the returned key as a string, or null if it isn't found.

Parameters
- Default value encoding: BufferEncoding = "utf8"
Returns Promise<{}>

then

then<R, V>(onFulfilled: (value: {}) => 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: {}) => R | Promise<R>
  - - (value: {}): R | Promise<R>
    - Parameters
      - value: {}
        
        [key: string]: string
      Returns R | Promise<R>
- Optional onRejected: undefined | ((err: any) => V | Promise<V>)
Returns Promise<R | V>

Generated using TypeDoc