Class LeaseClient

Index

Constructors

Methods

leaseGrant leaseKeepAlive leaseLeases leaseRevoke leaseTimeToLive

Constructors

constructor

new LeaseClient(client: ICallable<unknown>): LeaseClient
Parameters
- client: ICallable<unknown>
Returns LeaseClient
- Defined in src/rpc.ts:146

Methods

leaseGrant

leaseGrant(
req: ILeaseGrantRequest,
options?: CallOptions,
): Promise<ILeaseGrantResponse>
LeaseGrant creates a lease which expires if the server does not receive a keepAlive within a given time to live period. All keys attached to the lease will be expired and deleted if the lease expires. Each expired key generates a delete event in the event history.
Parameters
- req: ILeaseGrantRequest
- Optionaloptions: CallOptions
Returns Promise<ILeaseGrantResponse>
- Defined in src/rpc.ts:152

leaseKeepAlive

leaseKeepAlive(
options?: CallOptions,
): Promise<IDuplexStream<ILeaseKeepAliveRequest, ILeaseKeepAliveResponse>>
LeaseKeepAlive keeps the lease alive by streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client.
Parameters
- Optionaloptions: CallOptions
Returns Promise<IDuplexStream<ILeaseKeepAliveRequest, ILeaseKeepAliveResponse>>
- Defined in src/rpc.ts:171

leaseLeases

leaseLeases(options?: CallOptions): Promise<ILeaseLeasesResponse>
LeaseLeases lists all existing leases.
Parameters
- Optionaloptions: CallOptions
Returns Promise<ILeaseLeasesResponse>
- Defined in src/rpc.ts:199

leaseRevoke

leaseRevoke(
req: ILeaseRevokeRequest,
options?: CallOptions,
): Promise<ILeaseRevokeResponse>
LeaseRevoke revokes a lease. All keys attached to the lease will expire and be deleted.
Parameters
- req: ILeaseRevokeRequest
- Optionaloptions: CallOptions
Returns Promise<ILeaseRevokeResponse>
- Defined in src/rpc.ts:161

leaseTimeToLive

leaseTimeToLive(
req: ILeaseTimeToLiveRequest,
options?: CallOptions,
): Promise<ILeaseTimeToLiveResponse>
LeaseTimeToLive retrieves lease information.
Parameters
- req: ILeaseTimeToLiveRequest
- Optionaloptions: CallOptions
Returns Promise<ILeaseTimeToLiveResponse>
- Defined in src/rpc.ts:190