1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-07 02:26:19 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/mechanisms/StartupMechanism.tid
Jermolene 78ba57d55d Remove support for browser-startup modules
Instead support startup modules that stipulate which platform they
require.

Also include docs updates and fixes to fullscreen plugin
2014-05-03 17:49:20 +01:00

30 lines
1.3 KiB
Plaintext

created: 20140502142900000
modified: 20140502142900000
tags: mechanism dev
title: StartupMechanism
type: text/vnd.tiddlywiki
The startup mechanism runs the installed startup modules at the end of the [[boot process|BootMechanism]].
! Startup Modules
Modules with their ''module-type'' field set to `startup`:
* Must expose a `startup` function
** For synchronous startup modules the startup function is called as `startup()`, asynchronous modules are passed a callback they must invoke on completion: `startup(callback)`
* May expose a `name` property that is used to identify the task
* May expose a `after` property containing an array of names of dependent tasks that must be run before this one
* May expose a `platforms` property containing an array of names of platforms that are required in order for the startup module to be executed. The defined platforms are ''node'' and ''browser''
! Startup Processing
The startup mechanism begins by sequentially executing the tasks that have no dependencies. It then continues executing tasks as they are unlocked by the completion of their dependencies.
There is no guarantee of the execution order of tasks that share the same dependencies.
! Startup Tasks
The core defines the following sequence of named startup tasks:
|!Task Name |!Description |