utils/scheduler

Interfaces

Task

Defined in: utils/scheduler.ts:10

Extended by

• OneOffTask
• RecurringTask

Type Parameters

Type Parameter	Default type
D	unknown

Properties

Property	Type	Defined in
id	number	utils/scheduler.ts:11
type	"once" | "many"	utils/scheduler.ts:12
handler_name	string	utils/scheduler.ts:13
data?	D	utils/scheduler.ts:14

---

OneOffTask

Defined in: utils/scheduler.ts:17

Extends

• Task<D>

Type Parameters

Type Parameter	Default type
D	unknown

Properties

Property	Type	Overrides	Inherited from	Defined in
id	number	-	Task.id	utils/scheduler.ts:11
handler_name	string	-	Task.handler_name	utils/scheduler.ts:13
data?	D	-	Task.data	utils/scheduler.ts:14
type	"once"	Task.type	-	utils/scheduler.ts:18
at	number	-	-	utils/scheduler.ts:19

---

RecurringTask

Defined in: utils/scheduler.ts:22

Extends

• Task<D>

Type Parameters

Type Parameter	Default type
D	unknown

Properties

Property	Type	Overrides	Inherited from	Defined in
id	number	-	Task.id	utils/scheduler.ts:11
handler_name	string	-	Task.handler_name	utils/scheduler.ts:13
data?	D	-	Task.data	utils/scheduler.ts:14
type	"many"	Task.type	-	utils/scheduler.ts:23
period	number	-	-	utils/scheduler.ts:24
next	number	-	-	utils/scheduler.ts:25

---

SchedulerStorage

Defined in: utils/scheduler.ts:28

Properties

Property	Type	Defined in
tasks	Record<TaskId, Task<any> | undefined>	utils/scheduler.ts:29
at	Record<Tick, | Record<TaskId, boolean | undefined> | undefined>	utils/scheduler.ts:30
next_id	number	utils/scheduler.ts:31

Type Aliases

TaskId

type TaskId = number;

Defined in: utils/scheduler.ts:7

---

Tick

type Tick = number;

Defined in: utils/scheduler.ts:8

Variables

ABORT

const ABORT: typeof ABORT;

Defined in: utils/scheduler.ts:5

---

call_method_at

const call_method_at: (tick: number, serializable_object: any, method_name: string, ...args: any[]) => number = at_method;

Defined in: utils/scheduler.ts:232

Parameters

Parameter	Type
tick	number
serializable_object	any
method_name	string
…args	any[]

Returns

number

Functions

register_handler()

function register_handler<D>(name: string, handler: (this: void, task: Task<D>) => any): void;

Defined in: utils/scheduler.ts:36

Type Parameters

Type Parameter	Default type
D	unknown

Parameters

Parameter	Type
name	string
handler	(this: void, task: Task<D>) => any

Returns

void

---

get_sched_storage()

function get_sched_storage(): SchedulerStorage;

Defined in: utils/scheduler.ts:42

Returns

SchedulerStorage

---

at()

function at<D>(
   tick: number,
   handler_name: string,
   data?: D): number;

Defined in: utils/scheduler.ts:146

Type Parameters

Type Parameter	Default type
D	unknown

Parameters

Parameter	Type
tick	number
handler_name	string
data?	D

Returns

number

---

after()

function after<D>(
   ticks: number,
   handler_name: string,
   data?: D): number;

Defined in: utils/scheduler.ts:158

Type Parameters

Type Parameter	Default type
D	unknown

Parameters

Parameter	Type
ticks	number
handler_name	string
data?	D

Returns

number

---

every()

function every<D>(
   period: number,
   handler_name: string,
   data?: D,
   skew?: number): number;

Defined in: utils/scheduler.ts:166

Type Parameters

Type Parameter	Default type
D	unknown

Parameters

Parameter	Type
period	number
handler_name	string
data?	D
skew?	number

Returns

number

---

get()

function get<D>(task_id: number): Task<D>;

Defined in: utils/scheduler.ts:175

Type Parameters

Type Parameter	Default type
D	unknown

Parameters

Parameter	Type
task_id	number

Returns

Task<D>

---

set_period()

function set_period(task_id: number, period: number): void;

Defined in: utils/scheduler.ts:181

Parameters

Parameter	Type
task_id	number
period	number

Returns

void

---

stop()

function stop(task_id?: number): boolean;

Defined in: utils/scheduler.ts:187

Parameters

Parameter	Type
task_id?	number

Returns

boolean

---

at_method()

function at_method(
   tick: number,
   serializable_object: any,
   method_name: string, ...
   args: any[]): number;

Defined in: utils/scheduler.ts:228

Parameters

Parameter	Type
tick	number
serializable_object	any
method_name	string
…args	any[]

Returns

number

---

call_global_at()

function call_global_at(
   tick: number,
   func_path: string[], ...
   args: any[]): number;

Defined in: utils/scheduler.ts:234

Parameters

Parameter	Type
tick	number
func_path	string[]
…args	any[]

Returns

number