summaryrefslogtreecommitdiffstats
path: root/src/commands/publish.json
blob: 1dd757d69bcddf224e01f220f792525175734dae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
    "PUBLISH": {
        "summary": "Posts a message to a channel.",
        "complexity": "O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client).",
        "group": "pubsub",
        "since": "2.0.0",
        "arity": 3,
        "function": "publishCommand",
        "command_flags": [
            "PUBSUB",
            "LOADING",
            "STALE",
            "FAST",
            "MAY_REPLICATE",
            "SENTINEL"
        ],
        "arguments": [
            {
                "name": "channel",
                "type": "string"
            },
            {
                "name": "message",
                "type": "string"
            }
        ],
        "reply_schema": {
            "description": "the number of clients that received the message. Note that in a Redis Cluster, only clients that are connected to the same node as the publishing client are included in the count",
            "type": "integer",
            "minimum": 0
        }
    }
}