Skip to main content

PendingPromiseTracker

Tracks pending promises

Functions​

new​

</>
PendingPromiseTracker.new() → PendingPromiseTracker<T>

Returns a new pending promise tracker

Add​

</>
PendingPromiseTracker.Add(
self: PendingPromiseTracker<T...>,
promise: _Promise.Promise<T...>
) → ()

Adds a new promise to the tracker. If it's not pending it will not add.

GetAll​

</>
PendingPromiseTracker.GetAll(self: PendingPromiseTracker<T...>) → {_Promise.Promise<T...>}

Gets all of the promises that are pending

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Returns a new pending promise tracker",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PendingPromiseTracker<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/promise/src/Shared/Utility/PendingPromiseTracker.lua"
            }
        },
        {
            "name": "Add",
            "desc": "Adds a new promise to the tracker. If it's not pending it will not add.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PendingPromiseTracker<T...>"
                },
                {
                    "name": "promise",
                    "desc": "",
                    "lua_type": "_Promise.Promise<T...>"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/promise/src/Shared/Utility/PendingPromiseTracker.lua"
            }
        },
        {
            "name": "GetAll",
            "desc": "Gets all of the promises that are pending",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "PendingPromiseTracker<T...>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ _Promise.Promise<T...> }\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 50,
                "path": "src/promise/src/Shared/Utility/PendingPromiseTracker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PendingPromiseTracker",
    "desc": "Tracks pending promises",
    "source": {
        "line": 6,
        "path": "src/promise/src/Shared/Utility/PendingPromiseTracker.lua"
    }
}