Skip to content

$getTimeout

$getTimeout returns information about a specific timeout.

Usage

$getTimeout[timeoutId;key?]

Parameters

FieldTypeDescriptionRequired
timeoutIdnumberThe ID of the timeout.true
key?stringThe key value that will be returned.
1. key (default)
2. duration
3. id
false

Example(s)

This will return the duration of the specified timeout.

1
client.command({
2
name: "getTimeout",
3
code: `
4
$getTimeout[$get[timeoutID;duration] $comment[Example duration value, 1723905246347]
5
$let[timeoutID;$setTimeout[timeoutCommand;100s;{};true]]
6
`
7
});