Updated Pub/Sub documentation

This commit is contained in:
tidwall 2018-08-14 11:13:55 -07:00
parent b766792d82
commit 2e7130cda0
2 changed files with 234 additions and 2 deletions

View File

@ -1285,6 +1285,13 @@
"optional": true, "optional": true,
"multiple": true "multiple": true
}, },
{
"command": "EX",
"name": ["seconds"],
"type": ["double"],
"optional": true,
"multiple": false
},
{ {
"enum": ["NEARBY", "WITHIN", "INTERSECTS"] "enum": ["NEARBY", "WITHIN", "INTERSECTS"]
}, },
@ -1348,6 +1355,115 @@
], ],
"group": "webhook" "group": "webhook"
}, },
"SETCHAN": {
"summary": "Creates a pubsub channel which points to geofenced search",
"arguments": [
{
"name": "name",
"type": "string"
},
{
"command": "META",
"name": ["name", "value"],
"type": ["string", "string"],
"optional": true,
"multiple": true
},
{
"command": "EX",
"name": ["seconds"],
"type": ["double"],
"optional": true,
"multiple": false
},
{
"enum": ["NEARBY", "WITHIN", "INTERSECTS"]
},
{
"name": "key",
"type": "string"
},
{
"command": "FENCE",
"name": [],
"type": []
},
{
"command": "DETECT",
"name": ["what"],
"type": ["string"],
"optional": true
},
{
"command": "COMMANDS",
"name": ["which"],
"type": ["string"],
"optional": true
},
{
"name": "param",
"type": "string",
"variadic": true
}
],
"group": "pubsub"
},
"DELCHAN": {
"summary": "Removes a channel",
"arguments": [
{
"name": "name",
"type": "string"
}
],
"group": "pubsub"
},
"CHANS": {
"summary": "Finds all channels matching a pattern",
"arguments":[
{
"name": "pattern",
"type": "pattern"
}
],
"group": "pubsub"
},
"PDELCHAN": {
"summary": "Removes all channels matching a pattern",
"arguments":[
{
"name": "pattern",
"type": "pattern"
}
],
"group": "pubsub"
},
"PDEL": { "PDEL": {
"summary": "Removes all objects matching a pattern", "summary": "Removes all objects matching a pattern",
"arguments":[ "arguments":[

View File

@ -1451,6 +1451,13 @@ var commandsJSON = `{
"optional": true, "optional": true,
"multiple": true "multiple": true
}, },
{
"command": "EX",
"name": ["seconds"],
"type": ["double"],
"optional": true,
"multiple": false
},
{ {
"enum": ["NEARBY", "WITHIN", "INTERSECTS"] "enum": ["NEARBY", "WITHIN", "INTERSECTS"]
}, },
@ -1514,6 +1521,115 @@ var commandsJSON = `{
], ],
"group": "webhook" "group": "webhook"
}, },
"SETCHAN": {
"summary": "Creates a pubsub channel which points to geofenced search",
"arguments": [
{
"name": "name",
"type": "string"
},
{
"command": "META",
"name": ["name", "value"],
"type": ["string", "string"],
"optional": true,
"multiple": true
},
{
"command": "EX",
"name": ["seconds"],
"type": ["double"],
"optional": true,
"multiple": false
},
{
"enum": ["NEARBY", "WITHIN", "INTERSECTS"]
},
{
"name": "key",
"type": "string"
},
{
"command": "FENCE",
"name": [],
"type": []
},
{
"command": "DETECT",
"name": ["what"],
"type": ["string"],
"optional": true
},
{
"command": "COMMANDS",
"name": ["which"],
"type": ["string"],
"optional": true
},
{
"name": "param",
"type": "string",
"variadic": true
}
],
"group": "pubsub"
},
"DELCHAN": {
"summary": "Removes a channel",
"arguments": [
{
"name": "name",
"type": "string"
}
],
"group": "pubsub"
},
"CHANS": {
"summary": "Finds all channels matching a pattern",
"arguments":[
{
"name": "pattern",
"type": "pattern"
}
],
"group": "pubsub"
},
"PDELCHAN": {
"summary": "Removes all channels matching a pattern",
"arguments":[
{
"name": "pattern",
"type": "pattern"
}
],
"group": "pubsub"
},
"PDEL": { "PDEL": {
"summary": "Removes all objects matching a pattern", "summary": "Removes all objects matching a pattern",
"arguments":[ "arguments":[