0c3b8b7e90
This is an attempt to normalize/formalize command summaries. Main actions performed: * Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands. * Starts with "An internal command...", "A container command...", etc... when applicable. * Always uses periods. * Refrains from referring to other commands. If this is needed, backquotes should be used for command names. * Tries to be very clear about the data type when applicable. * Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed." * Prefers being terse over verbose. * Tries to be consistent.
81 lines
2.4 KiB
JSON
81 lines
2.4 KiB
JSON
{
|
|
"BLPOP": {
|
|
"summary": "Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
|
|
"complexity": "O(N) where N is the number of provided keys.",
|
|
"group": "list",
|
|
"since": "2.0.0",
|
|
"arity": -3,
|
|
"function": "blpopCommand",
|
|
"history": [
|
|
[
|
|
"6.0.0",
|
|
"`timeout` is interpreted as a double instead of an integer."
|
|
]
|
|
],
|
|
"command_flags": [
|
|
"WRITE",
|
|
"BLOCKING"
|
|
],
|
|
"acl_categories": [
|
|
"LIST"
|
|
],
|
|
"key_specs": [
|
|
{
|
|
"flags": [
|
|
"RW",
|
|
"ACCESS",
|
|
"DELETE"
|
|
],
|
|
"begin_search": {
|
|
"index": {
|
|
"pos": 1
|
|
}
|
|
},
|
|
"find_keys": {
|
|
"range": {
|
|
"lastkey": -2,
|
|
"step": 1,
|
|
"limit": 0
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null",
|
|
"description": "No element could be popped and timeout expired"
|
|
},
|
|
{
|
|
"description": "The key from which the element was popped and the value of the popped element",
|
|
"type": "array",
|
|
"minItems": 2,
|
|
"maxItems": 2,
|
|
"items": [
|
|
{
|
|
"description": "List key from which the element was popped.",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"description": "Value of the popped element.",
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"arguments": [
|
|
{
|
|
"name": "key",
|
|
"type": "key",
|
|
"key_spec_index": 0,
|
|
"multiple": true
|
|
},
|
|
{
|
|
"name": "timeout",
|
|
"type": "double"
|
|
}
|
|
]
|
|
}
|
|
}
|