function timeout_add(priority: Number(gint), interval: Number(guint), function: GLib.SourceFunc): Number(guint) {
    // Gjs wrapper for g_timeout_add_full()

Sets a function to be called at regular intervals, with the given priority. The function is called repeatedly until it returns false, at which point the timeout is automatically destroyed and the function will not be called again. The notify function is called when the timeout is destroyed. The first call to the function will be at the end of the first interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to 'catch up' time lost in delays).

This internally creates a main loop source using GLib.timeout_source_new and attaches it to the main loop context using GLib.Source.prototype.attach. You can do these steps manually if you need greater control.

The interval given in terms of monotonic time, not wall clock time. See GLib.get_monotonic_time.


the priority of the timeout source. Typically this will be in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.


the time between calls to the function, in milliseconds (1/1000ths of a second)


function to call


the ID (greater than 0) of the event source.