Interface RedisSession

A live Redis connection over a single socket.

Obtain one from connect. A background pump reads replies and routes them, so commands, pipelines, and Pub/Sub deliveries can all be in flight at once. It is an AsyncDisposable, so await using closes it cleanly.

send runs any command, which is the escape hatch for everything the typed methods below do not cover (streams, cluster commands, module commands, CONFIG, ...).

Since

1.0.6

interface RedisSession {
    protocol: 2 | 3;
    serverInfo: Record<string, RedisNative> | undefined;
    subscriptionCount: number;
    "[asyncDispose]"(): PromiseLike<void>;
    close(): Promise<void>;
    decr(key: string): Promise<number>;
    del(...keys: string[]): Promise<number>;
    eval(script: string, opts?: RedisEvalOptions): Promise<RedisReply>;
    evalSha(sha: string, opts?: RedisEvalOptions): Promise<RedisReply>;
    exists(...keys: string[]): Promise<number>;
    expire(key: string, seconds: number): Promise<boolean>;
    get(key: string): Promise<Uint8Array<ArrayBufferLike> | null>;
    getText(key: string): Promise<string | null>;
    hdel(key: string, ...fields: string[]): Promise<number>;
    hget(
        key: string,
        field: string,
    ): Promise<Uint8Array<ArrayBufferLike> | null>;
    hgetall(key: string): Promise<Record<string, string>>;
    hgetText(key: string, field: string): Promise<string | null>;
    hset(key: string, entries: Record<string, RedisArg>): Promise<number>;
    incr(key: string): Promise<number>;
    incrBy(key: string, by: number): Promise<number>;
    info(section?: string): Promise<Record<string, string>>;
    keys(pattern: string): Promise<string[]>;
    llen(key: string): Promise<number>;
    lpop(key: string): Promise<string | null>;
    lpush(key: string, ...values: RedisArg[]): Promise<number>;
    lrange(key: string, start: number, stop: number): Promise<string[]>;
    mget(keys: readonly string[]): Promise<(string | null)[]>;
    mset(entries: Record<string, RedisArg>): Promise<void>;
    multi(commands: readonly (readonly RedisArg[])[]): Promise<RedisReply[]>;
    ping(message?: string): Promise<string>;
    pipeline(commands: readonly (readonly RedisArg[])[]): Promise<RedisReply[]>;
    psubscribe(...patterns: string[]): Promise<RedisSubscription>;
    publish(channel: string, message: RedisArg): Promise<number>;
    publishJson(channel: string, value: unknown): Promise<number>;
    rpop(key: string): Promise<string | null>;
    rpush(key: string, ...values: RedisArg[]): Promise<number>;
    sadd(key: string, ...members: RedisArg[]): Promise<number>;
    scan(opts?: RedisScanOptions & { cursor?: string }): Promise<RedisScanPage>;
    scanIterator(opts?: RedisScanOptions): AsyncIterableIterator<string>;
    select(db: number): Promise<void>;
    send(...args: RedisArg[]): Promise<RedisReply>;
    set(key: string, value: RedisArg, opts?: RedisSetOptions): Promise<boolean>;
    sismember(key: string, member: RedisArg): Promise<boolean>;
    smembers(key: string): Promise<string[]>;
    srem(key: string, ...members: RedisArg[]): Promise<number>;
    subscribe(...channels: string[]): Promise<RedisSubscription>;
    ttl(key: string): Promise<number>;
    zadd(key: string, entries: Record<string, number>): Promise<number>;
    zrange(
        key: string,
        start: number,
        stop: number,
        opts?: { rev?: boolean },
    ): Promise<string[]>;
    zrangeWithScores(
        key: string,
        start: number,
        stop: number,
        opts?: { rev?: boolean },
    ): Promise<RedisScoreEntry[]>;
    zrem(key: string, ...members: RedisArg[]): Promise<number>;
}

Hierarchy

AsyncDisposable
- RedisSession

Index

Properties

`Readonly`protocol

protocol: 2 | 3

The RESP version in use on this connection.

`Readonly`serverInfo

serverInfo: Record<string, RedisNative> | undefined

The server properties from the HELLO handshake; only populated when protocol: 3.

`Readonly`subscriptionCount

subscriptionCount: number

How many channels and patterns the connection is currently subscribed to.

Methods

[asyncDispose]

"[asyncDispose]"(): PromiseLike<void>
Returns PromiseLike<void>
Inherited from AsyncDisposable.[asyncDispose]
- Defined in node_modules/typescript/lib/lib.esnext.disposable.d.ts:38

close

close(): Promise<void>
Closes the connection and ends every subscription.

Returns Promise<void>
Resolves once the socket is closed.
- Defined in src/redis/index.ts:644

decr

decr(key: string): Promise<number>
Decrements a key by one.
Parameters
- key: string
  The key to decrement.
Returns Promise<number>
The value after the decrement.
- Defined in src/redis/index.ts:349

del

del(...keys: string[]): Promise<number>
Deletes keys.
Parameters
- ...keys: string[]
  The keys to delete.
Returns Promise<number>
How many keys were removed.
- Defined in src/redis/index.ts:306

eval

eval(script: string, opts?: RedisEvalOptions): Promise<RedisReply>
Runs a Lua script on the server.
Parameters
- script: string
  The script source.
- Optionalopts: RedisEvalOptions
  The script's KEYS and ARGV.
Returns Promise<RedisReply>
The script's reply.

Throws
If the script raises an error.
- Defined in src/redis/index.ts:569

evalSha

evalSha(sha: string, opts?: RedisEvalOptions): Promise<RedisReply>
Runs a Lua script the server has already cached, by its SHA1.
Parameters
- sha: string
  The script's SHA1, as returned by SCRIPT LOAD.
- Optionalopts: RedisEvalOptions
  The script's KEYS and ARGV.
Returns Promise<RedisReply>
The script's reply.

Throws
If the script is not cached (NOSCRIPT) or raises an error.
- Defined in src/redis/index.ts:578

exists

exists(...keys: string[]): Promise<number>
Counts how many of the given keys exist.
Parameters
- ...keys: string[]
  The keys to test.
Returns Promise<number>
The number that exist (counting duplicates separately, as Redis does).
- Defined in src/redis/index.ts:313

expire

expire(key: string, seconds: number): Promise<boolean>
Sets a key's time to live.
Parameters
- key: string
  The key to expire.
- seconds: number
  Seconds until expiry.
Returns Promise<boolean>
True if the timeout was set, false if the key does not exist.
- Defined in src/redis/index.ts:357

get

get(key: string): Promise<Uint8Array<ArrayBufferLike> | null>
Gets a key's value as raw bytes.
Parameters
- key: string
  The key to read.
Returns Promise<Uint8Array<ArrayBufferLike> | null>
The bytes, or null if the key does not exist.
- Defined in src/redis/index.ts:283

getText

getText(key: string): Promise<string | null>
Gets a key's value as UTF-8 text.
Parameters
- key: string
  The key to read.
Returns Promise<string | null>
The value, or null if the key does not exist.
- Defined in src/redis/index.ts:290

hdel

hdel(key: string, ...fields: string[]): Promise<number>
Deletes hash fields.
Parameters
- key: string
  The hash key.
- ...fields: string[]
  The fields to remove.
Returns Promise<number>
How many fields were removed.
- Defined in src/redis/index.ts:427

hget

hget(key: string, field: string): Promise<Uint8Array<ArrayBufferLike> | null>
Gets a hash field as raw bytes.
Parameters
- key: string
  The hash key.
- field: string
  The field to read.
Returns Promise<Uint8Array<ArrayBufferLike> | null>
The bytes, or null if the field or key does not exist.
- Defined in src/redis/index.ts:403

hgetall

hgetall(key: string): Promise<Record<string, string>>
Reads a whole hash.

Normalizes the RESP2 flat array and the RESP3 map into the same object.
Parameters
- key: string
  The hash key.
Returns Promise<Record<string, string>>
The fields as a string-to-string object; empty if the key does not exist.
- Defined in src/redis/index.ts:436

hgetText

hgetText(key: string, field: string): Promise<string | null>
Gets a hash field as UTF-8 text.
Parameters
- key: string
  The hash key.
- field: string
  The field to read.
Returns Promise<string | null>
The value, or null if the field or key does not exist.
- Defined in src/redis/index.ts:411

hset

hset(key: string, entries: Record<string, RedisArg>): Promise<number>
Sets one or more hash fields.
Parameters
- key: string
  The hash key.
- entries: Record<string, RedisArg>
  Field-to-value pairs to write.
Returns Promise<number>
How many fields were newly added.
- Defined in src/redis/index.ts:419

incr

incr(key: string): Promise<number>
Increments a key by one.
Parameters
- key: string
  The key to increment.
Returns Promise<number>
The value after the increment.
- Defined in src/redis/index.ts:334

incrBy

incrBy(key: string, by: number): Promise<number>
Increments a key by an integer amount.
Parameters
- key: string
  The key to increment.
- by: number
  The amount to add (may be negative).
Returns Promise<number>
The value after the increment.
- Defined in src/redis/index.ts:342

info

info(section?: string): Promise<Record<string, string>>
Reads the server's INFO report, parsed into fields.
Parameters
- Optionalsection: string
  Optional section to limit the report to, e.g. 'memory'.
Returns Promise<Record<string, string>>
The report's key:value lines as an object (section headers are dropped).
- Defined in src/redis/index.ts:638

keys

keys(pattern: string): Promise<string[]>
Lists every key matching a pattern.

KEYS walks the whole keyspace, which blocks the server on a large database; prefer scanIterator outside of small datasets and one-off tooling.
Parameters
- pattern: string
  A glob-style pattern, e.g. 'session:*'.
Returns Promise<string[]>
The matching keys.
- Defined in src/redis/index.ts:374

llen

llen(key: string): Promise<number>
Reads a list's length.
Parameters
- key: string
  The list key.
Returns Promise<number>
The number of elements; 0 if the key does not exist.
- Defined in src/redis/index.ts:483

lpop

lpop(key: string): Promise<string | null>
Removes and returns the first element of a list.
Parameters
- key: string
  The list key.
Returns Promise<string | null>
The element as text, or null if the list is empty.
- Defined in src/redis/index.ts:460

lpush

lpush(key: string, ...values: RedisArg[]): Promise<number>
Prepends values to a list.
Parameters
- key: string
  The list key.
- ...values: RedisArg[]
  The values to prepend.
Returns Promise<number>
The list's length afterwards.
- Defined in src/redis/index.ts:445

lrange

lrange(key: string, start: number, stop: number): Promise<string[]>
Reads a range of a list.
Parameters
- key: string
  The list key.
- start: number
  First index (0-based; negative counts from the end).
- stop: number
  Last index, inclusive (-1 for the final element).
Returns Promise<string[]>
The elements as text.
- Defined in src/redis/index.ts:476

mget

mget(keys: readonly string[]): Promise<(string | null)[]>
Gets several keys at once.
Parameters
- keys: readonly string[]
  The keys to read.
Returns Promise<(string | null)[]>
One entry per key, null where the key does not exist.
- Defined in src/redis/index.ts:320

mset

mset(entries: Record<string, RedisArg>): Promise<void>
Sets several keys at once.
Parameters
- entries: Record<string, RedisArg>
  Key-to-value pairs to write.
Returns Promise<void>
Resolves once the server confirms.
- Defined in src/redis/index.ts:327

multi

multi(commands: readonly (readonly RedisArg[])[]): Promise<RedisReply[]>
Runs several commands atomically in a MULTI / EXEC transaction.

Like pipeline, a per-command failure surfaces on that reply's RedisReply.error rather than throwing.
Parameters
- commands: readonly (readonly RedisArg[])[]
  The commands to queue, in order.
Returns Promise<RedisReply[]>
One reply per command, as returned by EXEC.

Throws
If the server rejects a command at queue time and aborts the transaction, or if the transaction is discarded.

Throws
If the connection is closed.
- Defined in src/redis/index.ts:275

ping

ping(message?: string): Promise<string>
Pings the server.
Parameters
- Optionalmessage: string
  Optional payload the server echoes back.
Returns Promise<string>
'PONG', or the echoed message.
- Defined in src/redis/index.ts:624

pipeline

pipeline(commands: readonly (readonly RedisArg[])[]): Promise<RedisReply[]>
Runs several commands in one round trip and returns their replies in order.

Unlike send, a command that fails does not throw: its reply carries the message on RedisReply.error so one failure does not discard the other results. Reading such a reply's value throws, so a failure cannot be mistaken for data.
Parameters
- commands: readonly (readonly RedisArg[])[]
  The commands to run, in order.
Returns Promise<RedisReply[]>
One reply per command.

Throws
If the connection is closed.
- Defined in src/redis/index.ts:262

psubscribe

psubscribe(...patterns: string[]): Promise<RedisSubscription>
Subscribes to one or more glob-style channel patterns.
Parameters
- ...patterns: string[]
  The patterns to subscribe to, e.g. 'news.*'.
Returns Promise<RedisSubscription>
The subscription; each delivery carries the matched pattern.

Throws
If no patterns are given.
- Defined in src/redis/index.ts:616

publish

publish(channel: string, message: RedisArg): Promise<number>
Publishes a message to a channel.
Parameters
- channel: string
  The channel to publish to.
- message: RedisArg
  The payload (a string is UTF-8 encoded).
Returns Promise<number>
How many subscribers received it.
- Defined in src/redis/index.ts:587

publishJson

publishJson(channel: string, value: unknown): Promise<number>
Publishes a value as JSON to a channel.
Parameters
- channel: string
  The channel to publish to.
- value: unknown
  The value to serialize and publish.
Returns Promise<number>
How many subscribers received it.
- Defined in src/redis/index.ts:595

rpop

rpop(key: string): Promise<string | null>
Removes and returns the last element of a list.
Parameters
- key: string
  The list key.
Returns Promise<string | null>
The element as text, or null if the list is empty.
- Defined in src/redis/index.ts:467

rpush

rpush(key: string, ...values: RedisArg[]): Promise<number>
Appends values to a list.
Parameters
- key: string
  The list key.
- ...values: RedisArg[]
  The values to append.
Returns Promise<number>
The list's length afterwards.
- Defined in src/redis/index.ts:453

sadd

sadd(key: string, ...members: RedisArg[]): Promise<number>
Adds members to a set.
Parameters
- key: string
  The set key.
- ...members: RedisArg[]
  The members to add.
Returns Promise<number>
How many members were newly added.
- Defined in src/redis/index.ts:492

scan

scan(opts?: RedisScanOptions & { cursor?: string }): Promise<RedisScanPage>
Reads one page of the keyspace.
Parameters
- Optionalopts: RedisScanOptions & { cursor?: string }
  Cursor and filter options; omit cursor to start a new scan.
Returns Promise<RedisScanPage>
The page's keys and the cursor for the next call.
- Defined in src/redis/index.ts:381

scanIterator

scanIterator(opts?: RedisScanOptions): AsyncIterableIterator<string>
Walks the whole keyspace one page at a time, yielding each key.
Parameters
- Optionalopts: RedisScanOptions
  Filter options passed to each underlying SCAN.
Returns AsyncIterableIterator<string>
An async iterable of keys.
Example
```
for await (const key of redis.scanIterator({ match: 'session:*' })) {
	await redis.del(key);
}
```
- Defined in src/redis/index.ts:394

select

select(db: number): Promise<void>
Switches the connection to another database index.
Parameters
- db: number
  The database index.
Returns Promise<void>
Resolves once the server confirms.
- Defined in src/redis/index.ts:631

send

send(...args: RedisArg[]): Promise<RedisReply>
Runs one command and returns its reply.
Parameters
- ...args: RedisArg[]
  The command name followed by its arguments.
Returns Promise<RedisReply>
The reply.
Throws
If the server rejects the command for want of authorization.

Throws
If the server replies with an error.

Throws
If the connection is closed.
Example
```
const reply = await redis.send('SET', 'greeting', 'hello');
reply.text(); // 'OK'
```
- Defined in src/redis/index.ts:250

set

set(key: string, value: RedisArg, opts?: RedisSetOptions): Promise<boolean>
Sets a key, optionally with an expiry or an existence condition.
Parameters
- key: string
  The key to write.
- value: RedisArg
  The value (a string is UTF-8 encoded).
- Optionalopts: RedisSetOptions
  Expiry and NX / XX options.
Returns Promise<boolean>
True if the key was set; false when nx or xx prevented it.
- Defined in src/redis/index.ts:299

sismember

sismember(key: string, member: RedisArg): Promise<boolean>
Tests set membership.
Parameters
- key: string
  The set key.
- member: RedisArg
  The member to test.
Returns Promise<boolean>
True if the member is in the set.
- Defined in src/redis/index.ts:515

smembers

smembers(key: string): Promise<string[]>
Reads every member of a set.
Parameters
- key: string
  The set key.
Returns Promise<string[]>
The members as text; empty if the key does not exist.
- Defined in src/redis/index.ts:507

srem

srem(key: string, ...members: RedisArg[]): Promise<number>
Removes members from a set.
Parameters
- key: string
  The set key.
- ...members: RedisArg[]
  The members to remove.
Returns Promise<number>
How many members were removed.
- Defined in src/redis/index.ts:500

subscribe(...channels: string[]): Promise<RedisSubscription>
Subscribes to one or more channels.

Resolves once the server has confirmed every channel, so a publish issued afterwards is guaranteed to be delivered. On a protocol: 2 connection this puts the socket into subscriber mode, where Redis rejects ordinary commands until every subscription is released; protocol: 3 has no such restriction.
Parameters
- ...channels: string[]
  The channels to subscribe to.
Returns Promise<RedisSubscription>
The subscription.

Throws
If no channels are given.
- Defined in src/redis/index.ts:608

ttl

ttl(key: string): Promise<number>
Reads a key's remaining time to live.
Parameters
- key: string
  The key to inspect.
Returns Promise<number>
Seconds remaining, -1 if the key has no expiry, -2 if it does not exist.
- Defined in src/redis/index.ts:364

zadd

zadd(key: string, entries: Record<string, number>): Promise<number>
Adds scored members to a sorted set.
Parameters
- key: string
  The sorted-set key.
- entries: Record<string, number>
  Member-to-score pairs.
Returns Promise<number>
How many members were newly added.
- Defined in src/redis/index.ts:524

zrange

zrange(
    key: string,
    start: number,
    stop: number,
    opts?: { rev?: boolean },
): Promise<string[]>
Reads a range of a sorted set by rank.
Parameters
- key: string
  The sorted-set key.
- start: number
  First rank (0-based; negative counts from the end).
- stop: number
  Last rank, inclusive (-1 for the last member).
- Optionalopts: { rev?: boolean }
  Pass rev to order from highest score to lowest.
Returns Promise<string[]>
The members as text, in score order.
- Defined in src/redis/index.ts:542

zrangeWithScores

zrangeWithScores(
    key: string,
    start: number,
    stop: number,
    opts?: { rev?: boolean },
): Promise<RedisScoreEntry[]>
Reads a range of a sorted set by rank, with each member's score.

Normalizes the RESP2 flat array and the RESP3 member-score pairs into the same shape.
Parameters
- key: string
  The sorted-set key.
- start: number
  First rank (0-based; negative counts from the end).
- stop: number
  Last rank, inclusive (-1 for the last member).
- Optionalopts: { rev?: boolean }
  Pass rev to order from highest score to lowest.
Returns Promise<RedisScoreEntry[]>
The members with their scores, in score order.
- Defined in src/redis/index.ts:554

zrem

zrem(key: string, ...members: RedisArg[]): Promise<number>
Removes members from a sorted set.
Parameters
- key: string
  The sorted-set key.
- ...members: RedisArg[]
  The members to remove.
Returns Promise<number>
How many members were removed.
- Defined in src/redis/index.ts:532

Interface RedisSession

Since

Hierarchy

Index

Properties

Methods

Properties

Readonlyprotocol

ReadonlyserverInfo

ReadonlysubscriptionCount

Methods

[asyncDispose]

Returns PromiseLike<void>

close

Returns Promise<void>

decr

Parameters

Returns Promise<number>

del

Parameters

Returns Promise<number>

eval

Parameters

Returns Promise<RedisReply>

Throws

evalSha

Parameters

Returns Promise<RedisReply>

Throws

exists

Parameters

Returns Promise<number>

expire

Parameters

Returns Promise<boolean>

get

Parameters

Returns Promise<Uint8Array<ArrayBufferLike> | null>

getText

Parameters

Returns Promise<string | null>

hdel

Parameters

Returns Promise<number>

hget

Parameters

Returns Promise<Uint8Array<ArrayBufferLike> | null>

hgetall

Parameters

Returns Promise<Record<string, string>>

hgetText

Parameters

Returns Promise<string | null>

hset

Parameters

Returns Promise<number>

incr

Parameters

Returns Promise<number>

incrBy

Parameters

Returns Promise<number>

info

Parameters

Returns Promise<Record<string, string>>

keys

Parameters

Returns Promise<string[]>

llen

Parameters

Returns Promise<number>

lpop

Parameters

Returns Promise<string | null>

lpush

Parameters

Returns Promise<number>

lrange

Parameters

Returns Promise<string[]>

`Readonly`protocol

`Readonly`serverInfo

`Readonly`subscriptionCount