Interface RedisMessage

A message delivered to a RedisSubscription.

Since

1.0.6

interface RedisMessage {
    channel: string;
    pattern?: string;
    payload: Uint8Array;
    json<T = unknown>(): T;
    text(): string;
}

Index

Properties

channel pattern? payload

Methods

Properties

channel

channel: string

The channel the message was published to.

`Optional`pattern

pattern?: string

The pattern that matched, for a RedisSession.psubscribe delivery.

payload

payload: Uint8Array

The raw payload bytes.

Methods

json

json<T = unknown>(): T
Decodes the payload as UTF-8 then parses it as JSON.
Type Parameters
- T = unknown
  The expected shape of the decoded value.
Returns T
The parsed value.

Throws
If the payload is not valid JSON.
- Defined in src/redis/index.ts:190

text

text(): string
Decodes the payload as UTF-8 text.

Returns string
The payload as a string.
- Defined in src/redis/index.ts:182