Skip to main content

TimeSyncUtils

Helper functions for the TimeSyncService.

Functions​

promiseClockSynced​

</>
TimeSyncUtils.promiseClockSynced(clock: MasterClock | SlaveClock) → Promise<MasterClock | SlaveClock>

Given a clock, returns a promise that resolves when the clock is syncronized.

Show raw api
{
    "functions": [
        {
            "name": "promiseClockSynced",
            "desc": "Given a clock, returns a promise that resolves when the clock is syncronized.",
            "params": [
                {
                    "name": "clock",
                    "desc": "",
                    "lua_type": "MasterClock | SlaveClock"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<MasterClock | SlaveClock>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/timesyncservice/src/Shared/TimeSyncUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TimeSyncUtils",
    "desc": "Helper functions for the TimeSyncService.",
    "source": {
        "line": 5,
        "path": "src/timesyncservice/src/Shared/TimeSyncUtils.lua"
    }
}