LeaseClientWrapper | etcd3

Implements RPC.ICallable. Wraps a pool and adds the leaseID to outgoing put requests before executing them.

Hierarchy

LeaseClientWrapper

Implements

ICallable<Host>

Index

Constructors

constructor

Properties

callOptionsFactory

Methods

Constructors

constructor

new LeaseClientWrapper(pool: ConnectionPool, lease: { leaseID: Promise<string | Error>; emitLoss: any }): LeaseClientWrapper

- Defined in src/lease.ts:30
Parameters
- pool: ConnectionPool
- lease: { leaseID: Promise<string | Error>; emitLoss: any }
  - leaseID: Promise<string | Error>
  - emitLoss: function
    - emitLoss(err: EtcdError): void
    - Defined in src/lease.ts:36
      Parameters
      - err: EtcdError
      Returns void
Returns LeaseClientWrapper

Properties

Readonly callOptionsFactory

callOptionsFactory: undefined | CallOptions | ((context: CallContext) => CallOptions) = this.pool.callOptionsFactory

Methods

exec

exec(service: keyof typeof Services, method: string, payload: any): Promise<any>

- Defined in src/lease.ts:40
Parameters
- service: keyof typeof Services
- method: string
- payload: any
Returns Promise<any>

markFailed

markFailed(host: Host, error: Error): void

- Defined in src/lease.ts:50
Parameters
- host: Host
- error: Error
Returns void

withConnection

withConnection(): never

- Defined in src/lease.ts:54
Returns never

Generated using TypeDoc