Available since 2.0.0.

SUBSCRIBE channel [channel ...]

Subscribes the client to the specified channels.

Once the client enters the subscribed state it is not supposed to issue any other commands, except for additional SUBSCRIBE, PSUBSCRIBE, UNSUBSCRIBE, PUNSUBSCRIBE, PING and QUIT commands.

Return value

Array reply: The 'subscribe' keyword followed by [channel name, aggregate subscribe count] for each channel supplied.

Hierarchy

Constructors

Properties

blocking: boolean = true
dataType?: DataType

Used for "database" commands to enforce type checking.

logger: Logger = ...
maxParams: number = -1

Maximum number of parameters allowed. -1 for no maximum.

minParams: number = 1

Minimum number of parameters require.

name: string = "subscribe"
pubSubAllowed?: boolean

Used when PUB/SUB is in effect.

sign?: number

Sign is used in commands with a compliment command. The only current example is INCR/DECR. Sign is 1 for INCR and -1 for DECR

txIgnore?: boolean

Used in transactions to enqueue a command.

Methods