Class DeleteBuilder

DeleteBuilder builds a deletion.

Hierarchy

PromiseWrap<IDeleteRangeResponse>
- DeleteBuilder

Index

Constructors

Methods

all catch createPromise exec getPrevious inRange key op options prefix range then

Constructors

constructor

new DeleteBuilder(kv: KVClient, namespace: NSApplicator): DeleteBuilder
Parameters
- kv: KVClient
- namespace: NSApplicator
Returns DeleteBuilder
Overrides PromiseWrap<RPC.IDeleteRangeResponse>.constructor
- Defined in src/builder.ts:393

Methods

all

all(): this
All will instruct etcd to wipe all keys.

Returns this
- Defined in src/builder.ts:428

catch

catch<R>(
onRejected: (err: any) => R | Promise<R>,
): Promise<IDeleteRangeResponse | R>
catch implements Promiselike.catch()
Type Parameters
- R
Parameters
- onRejected: (err: any) => R | Promise<R>
Returns Promise<IDeleteRangeResponse | R>
Inherited from PromiseWrap.catch
- Defined in src/util.ts:234

`Protected`createPromise

createPromise(): Promise<IDeleteRangeResponse>
Returns Promise<IDeleteRangeResponse>
Overrides PromiseWrap.createPromise
- Defined in src/builder.ts:479

exec

exec(): Promise<IDeleteRangeResponse>
exec runs the delete put request.

Returns Promise<IDeleteRangeResponse>
- Defined in src/builder.ts:463

getPrevious

getPrevious(): Promise<IKeyValue[]>
getPrevious instructs etcd to try to get the previous value of the key before setting it. One may not always be available if a compaction takes place.

Returns Promise<IKeyValue[]>
- Defined in src/builder.ts:447

inRange

inRange(r: Rangable): this
inRange instructs the builder to delete keys in the specified byte range.
Parameters
- r: Rangable
Returns this
- Defined in src/builder.ts:435

key

key(value: string | Buffer<ArrayBufferLike>): this
key sets a single key to be deleted.
Parameters
- value: string | Buffer<ArrayBufferLike>
Returns this
- Defined in src/builder.ts:403

op

op(): Promise<IRequestOp>
Returns the request op for this builder, used in transactions.

Returns Promise<IRequestOp>
- Defined in src/builder.ts:470

options

options(options: CallOptions | undefined): this
Sets the GRPC call options for this request.
Parameters
- options: CallOptions | undefined
Returns this
- Defined in src/builder.ts:455

prefix

prefix(value: string | Buffer<ArrayBufferLike>): this
key sets a single key to be deleted.
Parameters
- value: string | Buffer<ArrayBufferLike>
Returns this
- Defined in src/builder.ts:412

range

range(range: Range): this
Sets the byte range of values to delete.
Parameters
- range: Range
Returns this
- Defined in src/builder.ts:419

then

then<R, V>(
onFulfilled: (value: IDeleteRangeResponse) => R | Promise<R>,
onRejected?: (err: any) => V | Promise<V>,
): Promise<R | V>
then implements Promiselike.then()
Type Parameters
- R
- V
Parameters
- onFulfilled: (value: IDeleteRangeResponse) => R | Promise<R>
- OptionalonRejected: (err: any) => V | Promise<V>
Returns Promise<R | V>
Inherited from PromiseWrap.then
- Defined in src/util.ts:224