Class PutBuilder

PutBuilder builds a "put" request to etcd.

Hierarchy

PromiseWrap<IPutResponse>
- PutBuilder

Index

Constructors

Methods

catch createPromise exec getPrevious ignoreLease lease op options then touch value

Constructors

constructor

new PutBuilder(
    kv: KVClient,
    namespace: NSApplicator,
    key: string | Buffer<ArrayBufferLike>,
): PutBuilder
Parameters
- kv: KVClient
- namespace: NSApplicator
- key: string | Buffer<ArrayBufferLike>
Returns PutBuilder
Overrides PromiseWrap<RPC.IPutResponse>.constructor
- Defined in src/builder.ts:492

Methods

catch

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

`Protected`createPromise

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

exec

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

Returns Promise<IPutResponse>
- Defined in src/builder.ts:557

getPrevious

getPrevious(): Promise<IKeyValue & { header: IResponseHeader }>
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 }>
- Defined in src/builder.ts:539

ignoreLease

ignoreLease(): this
Updates the key on its current lease, regardless of what that lease is.

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

lease

lease(lease: string | number | Promise<string | number>): this
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: string | number | Promise<string | number>
Returns this
- Defined in src/builder.ts:513

op

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

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

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:529

then

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

touch

touch(): Promise<IPutResponse>
Touch updates the key's revision without changing its value. This is equivalent to the etcd 'ignore value' flag.

Returns Promise<IPutResponse>
- Defined in src/builder.ts:548

value

value(value: string | number | Buffer<ArrayBufferLike>): this
value sets the value that will be stored in the key.
Parameters
- value: string | number | Buffer<ArrayBufferLike>
Returns this
- Defined in src/builder.ts:504