SingleRangeBuilder | etcd3

SingleRangeBuilder is a query builder that looks up a single key.

Hierarchy

RangeBuilder<string | null>
- SingleRangeBuilder

Implements

PromiseLike<string | null>
IOperation

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SingleRangeBuilder(kv: KVClient, namespace: NSApplicator, key: string | Buffer): SingleRangeBuilder

Overrides RangeBuilder.constructor
- Defined in src/builder.ts:135
Parameters
- kv: KVClient
- namespace: NSApplicator
- key: string | Buffer
Returns SingleRangeBuilder

Properties

Protected callOptions

callOptions: CallOptions | undefined

Protected Readonly namespace

namespace: NSApplicator

Protected request

request: IRangeRequest

Methods

buffer

buffer(): Promise<Buffer | null>

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

Returns Promise<Buffer | null>

catch

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

Protected createPromise

createPromise(): Promise<string | null>

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

Returns Promise<string | null>

exec

exec(): Promise<IRangeResponse>

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

Returns Promise<IRangeResponse>

exists

exists(): Promise<boolean>

- Defined in src/builder.ts:179
Returns whether the key exists.

Returns Promise<boolean>

json

json(): Promise<unknown>

- Defined in src/builder.ts:146
Runs the built request and parses the returned key as JSON, or returns null if it isn't found.

Returns Promise<unknown>

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

number

number(): Promise<number | null>

- Defined in src/builder.ts:164
Runs the built request, and returns the value parsed as a number. Resolves as NaN if the value can't be parsed as a number.

Returns Promise<number | null>

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

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

string

string(encoding?: BufferEncoding): Promise<string | null>

- Defined in src/builder.ts:154
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<string | null>

then

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

Generated using TypeDoc