ScheduleRegistry
Defined in: src/mft/ScheduleRegistry.ts:10
Mutable in-memory registry of MFT schedules.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScheduleRegistry(schedules?: Iterable<MftSchedule>): ScheduleRegistry;Defined in: src/mft/ScheduleRegistry.ts:18
Creates a registry and optionally seeds it with schedules.
Parameters
Section titled “Parameters”| Parameter | Type | Default value | Description |
|---|---|---|---|
schedules | Iterable<MftSchedule> | [] | Schedules to register immediately. |
Returns
Section titled “Returns”ScheduleRegistry
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size(): number;Defined in: src/mft/ScheduleRegistry.ts:93
Number of schedules currently registered.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”get(scheduleId: string): MftSchedule | undefined;Defined in: src/mft/ScheduleRegistry.ts:62
Gets a schedule when registered.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Section titled “Returns”MftSchedule | undefined
has(scheduleId: string): boolean;Defined in: src/mft/ScheduleRegistry.ts:57
Checks whether a schedule id is registered.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
scheduleId | string |
Returns
Section titled “Returns”boolean
list()
Section titled “list()”list(): MftSchedule[];Defined in: src/mft/ScheduleRegistry.ts:88
Returns all schedules in registration order.
Returns
Section titled “Returns”register()
Section titled “register()”register(schedule: MftSchedule): this;Defined in: src/mft/ScheduleRegistry.ts:31
Registers a schedule.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
schedule | MftSchedule | Schedule to add. |
Returns
Section titled “Returns”this
This registry for fluent setup.
Throws
Section titled “Throws”ConfigurationError When the schedule is malformed or a duplicate.
require()
Section titled “require()”require(scheduleId: string): MftSchedule;Defined in: src/mft/ScheduleRegistry.ts:73
Gets a schedule or throws when missing.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
scheduleId | string | Schedule id to retrieve. |
Returns
Section titled “Returns”The schedule.
Throws
Section titled “Throws”ConfigurationError When no schedule is registered under the id.
unregister()
Section titled “unregister()”unregister(scheduleId: string): boolean;Defined in: src/mft/ScheduleRegistry.ts:52
Removes a schedule.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
scheduleId | string | Schedule id to remove. |
Returns
Section titled “Returns”boolean
true when a schedule was removed.