Redis | @vertx/redis-client

A simple Redis client.

Hierarchy

Redis

Index

Methods

batch

batch(commands: Request): PromiseLike<Response>
batch(commands: Request, onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>): Redis

- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:830
Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

Parameters
- commands: Request
Returns PromiseLike<Response>
- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:836
Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

Parameters
- commands: Request
- onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>
Returns Redis

close

close(): void

- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:814
Closes the client and terminates any connection.

Returns void

connect

connect(): PromiseLike<RedisConnection>
connect(handler: ((res: AsyncResult<RedisConnection>) => void) | Handler<AsyncResult<RedisConnection>>): Redis

- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:804
Connects to the redis server.

Returns PromiseLike<RedisConnection>
- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:809
Connects to the redis server.

Parameters
- handler: ((res: AsyncResult<RedisConnection>) => void) | Handler<AsyncResult<RedisConnection>>
Returns Redis

send

send(command: Request): PromiseLike<Response>
send(command: Request, onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>): Redis

- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:819
Send the given command to the redis server or cluster.

Parameters
- command: Request
Returns PromiseLike<Response>
- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:824
Send the given command to the redis server or cluster.

Parameters
- command: Request
- onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>
Returns Redis

Static createClient

createClient(vertx: Vertx): Redis
createClient(vertx: Vertx, connectionString: string): Redis
createClient(vertx: Vertx, options: RedisOptions): Redis

- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:789
Create a new redis client using the default client options.

Parameters
- vertx: Vertx
Returns Redis
- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:794
Create a new redis client using the default client options. Does not support rediss (redis over ssl scheme) for now.

Parameters
- vertx: Vertx
- connectionString: string
Returns Redis
- Defined in io.vertx/vertx-redis-client/target/npm/index.d.ts:799
Create a new redis client using the given client options.

Parameters
- vertx: Vertx
- options: RedisOptions
Returns Redis

Hierarchy

Index

Methods

Methods

batch

Parameters

commands: Request

Returns PromiseLike<Response>

Parameters

commands: Request

onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>

Returns Redis

close

Returns void

connect

Returns PromiseLike<RedisConnection>

Parameters

handler: ((res: AsyncResult<RedisConnection>) => void) | Handler<AsyncResult<RedisConnection>>

Returns Redis

send

Parameters

command: Request

Returns PromiseLike<Response>

Parameters

command: Request

onSend: ((res: AsyncResult<Response>) => void) | Handler<AsyncResult<Response>>

Returns Redis

Static createClient

Parameters

vertx: Vertx

Returns Redis

Parameters

vertx: Vertx

connectionString: string

Returns Redis

Parameters

vertx: Vertx

options: RedisOptions

Returns Redis