DeleteBuilder | etcd3

DeleteBuilder builds a deletion.

Hierarchy

PromiseWrap<IDeleteRangeResponse>
- DeleteBuilder

Implements

PromiseLike<IDeleteRangeResponse>

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in src/builder.ts:354
Parameters
- kv: KVClient
- namespace: NSApplicator
Returns DeleteBuilder

Methods

all

all(): this

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

Returns this

catch

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

Protected createPromise

createPromise(): Promise<IDeleteRangeResponse>

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

Returns Promise<IDeleteRangeResponse>

exec

exec(): Promise<IDeleteRangeResponse>

- Defined in src/builder.ts:423
exec runs the delete put request.

Returns Promise<IDeleteRangeResponse>

getPrevious

getPrevious(): Promise<IKeyValue[]>

- Defined in src/builder.ts:407
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[]>

inRange

inRange(r: Rangable): this

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

Parameters
- r: Rangable
Returns this

key

key(value: string | Buffer): this

- Defined in src/builder.ts:363
key sets a single key to be deleted.

Parameters
- value: string | Buffer
Returns this

op

op(): Promise<IRequestOp>

- Defined in src/builder.ts:430
Returns the request op for this builder, used in transactions.

Returns Promise<IRequestOp>

options

options(options: CallOptions | undefined): this

- Defined in src/builder.ts:415
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:372
key sets a single key to be deleted.

Parameters
- value: string | Buffer
Returns this

range

range(range: Range): this

- Defined in src/builder.ts:379
Sets the byte range of values to delete.

Parameters
- range: Range
Returns this

then

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

Generated using TypeDoc