Skip to main content

MemoryStoreUtils

Wraps MemoryService APIs

Functions​

promiseAdd​

</>
MemoryStoreUtils.promiseAdd(
value: any,
expirationSeconds: number,
priority: number?
) → Promise

Promises to add from the queue

promiseRead​

</>
MemoryStoreUtils.promiseRead(
count: number,
allOrNothing: boolean,
waitTimeout: number
) → Promise<(
any?,
string?
)>

Promises to read from the queue

promiseRemove​

</>
MemoryStoreUtils.promiseRemove(
id: string
) → Promise

Promises to remove from the queue

Show raw api
{
    "functions": [
        {
            "name": "promiseAdd",
            "desc": "Promises to add from the queue",
            "params": [
                {
                    "name": "queue",
                    "desc": "",
                    "lua_type": "MemoryStoreQueue"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "any"
                },
                {
                    "name": "expirationSeconds",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/memorystoreutils/src/MemoryStoreUtils.lua"
            }
        },
        {
            "name": "promiseRead",
            "desc": "Promises to read from the queue",
            "params": [
                {
                    "name": "queue",
                    "desc": "",
                    "lua_type": "MemoryStoreQueue"
                },
                {
                    "name": "count",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "allOrNothing",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "waitTimeout",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<(any?, string?)>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 56,
                "path": "src/memorystoreutils/src/MemoryStoreUtils.lua"
            }
        },
        {
            "name": "promiseRemove",
            "desc": "Promises to remove from the queue",
            "params": [
                {
                    "name": "queue",
                    "desc": "",
                    "lua_type": "MemoryStoreQueue"
                },
                {
                    "name": "id",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 96,
                "path": "src/memorystoreutils/src/MemoryStoreUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MemoryStoreUtils",
    "desc": "Wraps MemoryService APIs",
    "source": {
        "line": 5,
        "path": "src/memorystoreutils/src/MemoryStoreUtils.lua"
    }
}