PutBuilder | etcd3

PutBuilder builds a "put" request to etcd.

Hierarchy

PromiseWrap<IPutResponse>
- PutBuilder

Implements

PromiseLike<IPutResponse>

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in src/builder.ts:450
Parameters
- kv: KVClient
- namespace: NSApplicator
- key: string | Buffer
Returns PutBuilder

Methods

catch

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

Protected createPromise

createPromise(): Promise<IPutResponse>

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

Returns Promise<IPutResponse>

exec

exec(): Promise<IPutResponse>

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

Returns Promise<IPutResponse>

getPrevious

getPrevious(): Promise<IKeyValue & { header: IResponseHeader }>

- Defined in src/builder.ts:499
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 & { header: IResponseHeader }>

ignoreLease

ignoreLease(): this

- Defined in src/builder.ts:481
Updates the key on its current lease, regardless of what that lease is.

Returns this

lease

lease(lease: number | string | Promise<string | number>): this

- Defined in src/builder.ts:473
Sets the lease value to use for storing the key. You usually don't need to use this directly, use client.lease() instead!

Parameters
- lease: number | string | Promise<string | number>
Returns this

op

op(): Promise<IRequestOp>

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

Returns Promise<IRequestOp>

options

options(options: CallOptions | undefined): this

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

Parameters
- options: CallOptions | undefined
Returns this

then

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

touch

touch(): Promise<IPutResponse>

- Defined in src/builder.ts:508
Touch updates the key's revision without changing its value. This is equivalent to the etcd 'ignore value' flag.

Returns Promise<IPutResponse>

value

value(value: string | Buffer | number): this

- Defined in src/builder.ts:464
value sets the value that will be stored in the key.

Parameters
- value: string | Buffer | number
Returns this

Generated using TypeDoc