From 5638d97cbfc023370d2752d9164714dd777ec1ce Mon Sep 17 00:00:00 2001 From: Roger Qiu Date: Sun, 3 Sep 2023 16:09:28 +1000 Subject: [PATCH 1/4] feat: integrated `@matrixai/events` to dispatch events for start, stop and destroy --- .eslintrc | 1 + docs/assets/search.js | 2 +- docs/classes/errors.ErrorAsyncInit.html | 1 + .../errors.ErrorAsyncInitDestroyed.html | 1 + .../errors.ErrorAsyncInitNotRunning.html | 1 + .../classes/errors.ErrorAsyncInitRunning.html | 1 + docs/classes/events.EventAsyncInit.html | 475 ++++++++++++++++++ .../classes/events.EventAsyncInitDestroy.html | 453 +++++++++++++++++ .../events.EventAsyncInitDestroyed.html | 453 +++++++++++++++++ docs/classes/events.EventAsyncInitStart.html | 453 +++++++++++++++++ .../classes/events.EventAsyncInitStarted.html | 453 +++++++++++++++++ docs/classes/events.EventAsyncInitStop.html | 453 +++++++++++++++++ .../classes/events.EventAsyncInitStopped.html | 453 +++++++++++++++++ .../createDestroy.CreateDestroy-1.html | 21 +- docs/functions/createDestroy.ready.html | 3 +- ...royStartStop.CreateDestroyStartStop-1.html | 28 +- .../createDestroyStartStop.ready.html | 3 +- docs/functions/startStop.StartStop-1.html | 25 +- docs/functions/startStop.ready.html | 3 +- docs/index.html | 1 + .../createDestroy.CreateDestroy.html | 119 ++++- ...stroyStartStop.CreateDestroyStartStop.html | 123 ++++- docs/interfaces/startStop.StartStop.html | 121 ++++- docs/modules.html | 2 + docs/modules/createDestroy.html | 1 + docs/modules/createDestroyStartStop.html | 1 + docs/modules/errors.html | 1 + docs/modules/events.html | 73 +++ docs/modules/startStop.html | 1 + docs/modules/types.html | 5 +- docs/types/types.Class.html | 75 +++ docs/types/types.Status.html | 4 +- .../createDestroyStartStop.destroyed.html | 1 + .../createDestroyStartStop.initLock.html | 1 + .../createDestroyStartStop.running.html | 1 + .../createDestroyStartStop.status.html | 1 + package-lock.json | 11 +- package.json | 3 +- pkgs.nix | 2 +- scripts/brew-install.sh | 4 +- scripts/choco-install.ps1 | 6 +- shell.nix | 2 +- src/CreateDestroy.ts | 24 +- src/CreateDestroyStartStop.ts | 44 +- src/StartStop.ts | 36 +- src/events.ts | 25 + src/index.ts | 1 + src/types.ts | 4 +- tests/CreateDestroy.test.ts | 28 ++ tests/CreateDestroyStartStop.test.ts | 77 +++ tests/StartStop.test.ts | 54 ++ 51 files changed, 4044 insertions(+), 91 deletions(-) create mode 100644 docs/classes/events.EventAsyncInit.html create mode 100644 docs/classes/events.EventAsyncInitDestroy.html create mode 100644 docs/classes/events.EventAsyncInitDestroyed.html create mode 100644 docs/classes/events.EventAsyncInitStart.html create mode 100644 docs/classes/events.EventAsyncInitStarted.html create mode 100644 docs/classes/events.EventAsyncInitStop.html create mode 100644 docs/classes/events.EventAsyncInitStopped.html create mode 100644 docs/modules/events.html create mode 100644 docs/types/types.Class.html create mode 100644 src/events.ts diff --git a/.eslintrc b/.eslintrc index ca2f535..9281326 100644 --- a/.eslintrc +++ b/.eslintrc @@ -38,6 +38,7 @@ "message": "Use `globalThis` instead" } ], + "prefer-rest-params": 0, "require-yield": 0, "eqeqeq": ["error", "smart"], "spaced-comment": [ diff --git a/docs/assets/search.js b/docs/assets/search.js index 1451143..92a9282 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":4,\"name\":\"types\",\"url\":\"modules/types.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Status\",\"url\":\"types/types.Status.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4,\"name\":\"createDestroyStartStop\",\"url\":\"modules/createDestroyStartStop.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"CreateDestroyStartStop\",\"url\":\"functions/createDestroyStartStop.CreateDestroyStartStop-1.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroyStartStop.CreateDestroyStartStop-1.html#CreateDestroyStartStop.__type\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":256,\"name\":\"CreateDestroyStartStop\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#constructor\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"start\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#start\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"stop\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#stop\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"destroy\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#destroy\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[running]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_running_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[destroyed]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_destroyed_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_status_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_initLock_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/createDestroyStartStop.ready.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroyStartStop.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.ready.ready\"},{\"kind\":32,\"name\":\"running\",\"url\":\"variables/createDestroyStartStop.running.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"destroyed\",\"url\":\"variables/createDestroyStartStop.destroyed.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"status\",\"url\":\"variables/createDestroyStartStop.status.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"initLock\",\"url\":\"variables/createDestroyStartStop.initLock.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":4,\"name\":\"createDestroy\",\"url\":\"modules/createDestroy.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"CreateDestroy\",\"url\":\"functions/createDestroy.CreateDestroy-1.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroy.CreateDestroy-1.html#CreateDestroy.__type\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy.CreateDestroy\"},{\"kind\":256,\"name\":\"CreateDestroy\",\"url\":\"interfaces/createDestroy.CreateDestroy.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#constructor\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":2048,\"name\":\"destroy\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#destroy\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":262144,\"name\":\"[destroyed]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_destroyed_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_status_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_initLock_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/createDestroy.ready.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroy.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"createDestroy.ready.ready\"},{\"kind\":8388608,\"name\":\"destroyed\",\"url\":\"modules/createDestroy.html#destroyed\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules/createDestroy.html#status\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules/createDestroy.html#initLock\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":4,\"name\":\"startStop\",\"url\":\"modules/startStop.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"StartStop\",\"url\":\"functions/startStop.StartStop-1.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/startStop.StartStop-1.html#StartStop.__type\",\"classes\":\"\",\"parent\":\"startStop.StartStop.StartStop\"},{\"kind\":256,\"name\":\"StartStop\",\"url\":\"interfaces/startStop.StartStop.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/startStop.StartStop.html#constructor\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":2048,\"name\":\"start\",\"url\":\"interfaces/startStop.StartStop.html#start\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":2048,\"name\":\"stop\",\"url\":\"interfaces/startStop.StartStop.html#stop\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":262144,\"name\":\"[running]\",\"url\":\"interfaces/startStop.StartStop.html#_running_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/startStop.StartStop.html#_status_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/startStop.StartStop.html#_initLock_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/startStop.ready.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/startStop.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"startStop.ready.ready\"},{\"kind\":8388608,\"name\":\"running\",\"url\":\"modules/startStop.html#running\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules/startStop.html#status\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules/startStop.html#initLock\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":4,\"name\":\"errors\",\"url\":\"modules/errors.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"ErrorAsyncInit\",\"url\":\"classes/errors.ErrorAsyncInit.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInit.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInit\"},{\"kind\":128,\"name\":\"ErrorAsyncInitRunning\",\"url\":\"classes/errors.ErrorAsyncInitRunning.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitRunning.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitRunning\"},{\"kind\":128,\"name\":\"ErrorAsyncInitNotRunning\",\"url\":\"classes/errors.ErrorAsyncInitNotRunning.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitNotRunning.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitNotRunning\"},{\"kind\":128,\"name\":\"ErrorAsyncInitDestroyed\",\"url\":\"classes/errors.ErrorAsyncInitDestroyed.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitDestroyed.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitDestroyed\"},{\"kind\":8388608,\"name\":\"running\",\"url\":\"modules.html#running\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"destroyed\",\"url\":\"modules.html#destroyed\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules.html#status\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules.html#initLock\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,37.377]],[\"comment/0\",[]],[\"name/1\",[1,20.031]],[\"comment/1\",[]],[\"name/2\",[2,28.904]],[\"comment/2\",[]],[\"name/3\",[2,28.904]],[\"comment/3\",[]],[\"name/4\",[3,22.713]],[\"comment/4\",[]],[\"name/5\",[2,28.904]],[\"comment/5\",[]],[\"name/6\",[4,28.904]],[\"comment/6\",[]],[\"name/7\",[5,32.268]],[\"comment/7\",[]],[\"name/8\",[6,32.268]],[\"comment/8\",[]],[\"name/9\",[7,32.268]],[\"comment/9\",[]],[\"name/10\",[8,24.384]],[\"comment/10\",[]],[\"name/11\",[9,24.384]],[\"comment/11\",[]],[\"name/12\",[1,20.031]],[\"comment/12\",[]],[\"name/13\",[10,21.282]],[\"comment/13\",[]],[\"name/14\",[11,28.904]],[\"comment/14\",[]],[\"name/15\",[3,22.713]],[\"comment/15\",[]],[\"name/16\",[8,24.384]],[\"comment/16\",[]],[\"name/17\",[9,24.384]],[\"comment/17\",[]],[\"name/18\",[1,20.031]],[\"comment/18\",[]],[\"name/19\",[10,21.282]],[\"comment/19\",[]],[\"name/20\",[12,28.904]],[\"comment/20\",[]],[\"name/21\",[12,28.904]],[\"comment/21\",[]],[\"name/22\",[3,22.713]],[\"comment/22\",[]],[\"name/23\",[12,28.904]],[\"comment/23\",[]],[\"name/24\",[4,28.904]],[\"comment/24\",[]],[\"name/25\",[7,32.268]],[\"comment/25\",[]],[\"name/26\",[9,24.384]],[\"comment/26\",[]],[\"name/27\",[1,20.031]],[\"comment/27\",[]],[\"name/28\",[10,21.282]],[\"comment/28\",[]],[\"name/29\",[11,28.904]],[\"comment/29\",[]],[\"name/30\",[3,22.713]],[\"comment/30\",[]],[\"name/31\",[9,24.384]],[\"comment/31\",[]],[\"name/32\",[1,20.031]],[\"comment/32\",[]],[\"name/33\",[10,21.282]],[\"comment/33\",[]],[\"name/34\",[13,28.904]],[\"comment/34\",[]],[\"name/35\",[13,28.904]],[\"comment/35\",[]],[\"name/36\",[3,22.713]],[\"comment/36\",[]],[\"name/37\",[13,28.904]],[\"comment/37\",[]],[\"name/38\",[4,28.904]],[\"comment/38\",[]],[\"name/39\",[5,32.268]],[\"comment/39\",[]],[\"name/40\",[6,32.268]],[\"comment/40\",[]],[\"name/41\",[8,24.384]],[\"comment/41\",[]],[\"name/42\",[1,20.031]],[\"comment/42\",[]],[\"name/43\",[10,21.282]],[\"comment/43\",[]],[\"name/44\",[11,28.904]],[\"comment/44\",[]],[\"name/45\",[3,22.713]],[\"comment/45\",[]],[\"name/46\",[8,24.384]],[\"comment/46\",[]],[\"name/47\",[1,20.031]],[\"comment/47\",[]],[\"name/48\",[10,21.282]],[\"comment/48\",[]],[\"name/49\",[14,37.377]],[\"comment/49\",[]],[\"name/50\",[15,37.377]],[\"comment/50\",[]],[\"name/51\",[16,26.391]],[\"comment/51\",[]],[\"name/52\",[17,37.377]],[\"comment/52\",[]],[\"name/53\",[16,26.391]],[\"comment/53\",[]],[\"name/54\",[18,37.377]],[\"comment/54\",[]],[\"name/55\",[16,26.391]],[\"comment/55\",[]],[\"name/56\",[19,37.377]],[\"comment/56\",[]],[\"name/57\",[16,26.391]],[\"comment/57\",[]],[\"name/58\",[8,24.384]],[\"comment/58\",[]],[\"name/59\",[9,24.384]],[\"comment/59\",[]],[\"name/60\",[1,20.031]],[\"comment/60\",[]],[\"name/61\",[10,21.282]],[\"comment/61\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":3,\"name\":{\"4\":{},\"15\":{},\"22\":{},\"30\":{},\"36\":{},\"45\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":4,\"name\":{\"6\":{},\"24\":{},\"38\":{}},\"comment\":{}}],[\"createdestroy\",{\"_index\":12,\"name\":{\"20\":{},\"21\":{},\"23\":{}},\"comment\":{}}],[\"createdestroystartstop\",{\"_index\":2,\"name\":{\"2\":{},\"3\":{},\"5\":{}},\"comment\":{}}],[\"description\",{\"_index\":16,\"name\":{\"51\":{},\"53\":{},\"55\":{},\"57\":{}},\"comment\":{}}],[\"destroy\",{\"_index\":7,\"name\":{\"9\":{},\"25\":{}},\"comment\":{}}],[\"destroyed\",{\"_index\":9,\"name\":{\"11\":{},\"17\":{},\"26\":{},\"31\":{},\"59\":{}},\"comment\":{}}],[\"errorasyncinit\",{\"_index\":15,\"name\":{\"50\":{}},\"comment\":{}}],[\"errorasyncinitdestroyed\",{\"_index\":19,\"name\":{\"56\":{}},\"comment\":{}}],[\"errorasyncinitnotrunning\",{\"_index\":18,\"name\":{\"54\":{}},\"comment\":{}}],[\"errorasyncinitrunning\",{\"_index\":17,\"name\":{\"52\":{}},\"comment\":{}}],[\"errors\",{\"_index\":14,\"name\":{\"49\":{}},\"comment\":{}}],[\"initlock\",{\"_index\":10,\"name\":{\"13\":{},\"19\":{},\"28\":{},\"33\":{},\"43\":{},\"48\":{},\"61\":{}},\"comment\":{}}],[\"ready\",{\"_index\":11,\"name\":{\"14\":{},\"29\":{},\"44\":{}},\"comment\":{}}],[\"running\",{\"_index\":8,\"name\":{\"10\":{},\"16\":{},\"41\":{},\"46\":{},\"58\":{}},\"comment\":{}}],[\"start\",{\"_index\":5,\"name\":{\"7\":{},\"39\":{}},\"comment\":{}}],[\"startstop\",{\"_index\":13,\"name\":{\"34\":{},\"35\":{},\"37\":{}},\"comment\":{}}],[\"status\",{\"_index\":1,\"name\":{\"1\":{},\"12\":{},\"18\":{},\"27\":{},\"32\":{},\"42\":{},\"47\":{},\"60\":{}},\"comment\":{}}],[\"stop\",{\"_index\":6,\"name\":{\"8\":{},\"40\":{}},\"comment\":{}}],[\"types\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"rows\":[{\"kind\":4,\"name\":\"types\",\"url\":\"modules/types.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"Status\",\"url\":\"types/types.Status.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":4194304,\"name\":\"Class\",\"url\":\"types/types.Class.html\",\"classes\":\"\",\"parent\":\"types\"},{\"kind\":512,\"name\":\"__type\",\"url\":\"types/types.Class.html#__type\",\"classes\":\"\",\"parent\":\"types.Class\"},{\"kind\":4,\"name\":\"createDestroyStartStop\",\"url\":\"modules/createDestroyStartStop.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"CreateDestroyStartStop\",\"url\":\"functions/createDestroyStartStop.CreateDestroyStartStop-1.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroyStartStop.CreateDestroyStartStop-1.html#CreateDestroyStartStop.__type\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":256,\"name\":\"CreateDestroyStartStop\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#constructor\",\"classes\":\"tsd-is-inherited\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"start\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#start\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"stop\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#stop\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":2048,\"name\":\"destroy\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#destroy\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[running]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_running_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[destroyed]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_destroyed_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_status_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/createDestroyStartStop.CreateDestroyStartStop.html#_initLock_\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.CreateDestroyStartStop\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/createDestroyStartStop.ready.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroyStartStop.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"createDestroyStartStop.ready.ready\"},{\"kind\":32,\"name\":\"running\",\"url\":\"variables/createDestroyStartStop.running.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"destroyed\",\"url\":\"variables/createDestroyStartStop.destroyed.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"status\",\"url\":\"variables/createDestroyStartStop.status.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":32,\"name\":\"initLock\",\"url\":\"variables/createDestroyStartStop.initLock.html\",\"classes\":\"\",\"parent\":\"createDestroyStartStop\"},{\"kind\":4,\"name\":\"createDestroy\",\"url\":\"modules/createDestroy.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"CreateDestroy\",\"url\":\"functions/createDestroy.CreateDestroy-1.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroy.CreateDestroy-1.html#CreateDestroy.__type\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy.CreateDestroy\"},{\"kind\":256,\"name\":\"CreateDestroy\",\"url\":\"interfaces/createDestroy.CreateDestroy.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#constructor\",\"classes\":\"tsd-is-inherited\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":2048,\"name\":\"destroy\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#destroy\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":262144,\"name\":\"[destroyed]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_destroyed_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_status_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/createDestroy.CreateDestroy.html#_initLock_\",\"classes\":\"\",\"parent\":\"createDestroy.CreateDestroy\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/createDestroy.ready.html\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/createDestroy.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"createDestroy.ready.ready\"},{\"kind\":8388608,\"name\":\"destroyed\",\"url\":\"modules/createDestroy.html#destroyed\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules/createDestroy.html#status\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules/createDestroy.html#initLock\",\"classes\":\"\",\"parent\":\"createDestroy\"},{\"kind\":4,\"name\":\"startStop\",\"url\":\"modules/startStop.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"StartStop\",\"url\":\"functions/startStop.StartStop-1.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/startStop.StartStop-1.html#StartStop.__type\",\"classes\":\"\",\"parent\":\"startStop.StartStop.StartStop\"},{\"kind\":256,\"name\":\"StartStop\",\"url\":\"interfaces/startStop.StartStop.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"interfaces/startStop.StartStop.html#constructor\",\"classes\":\"tsd-is-inherited\",\"parent\":\"startStop.StartStop\"},{\"kind\":2048,\"name\":\"start\",\"url\":\"interfaces/startStop.StartStop.html#start\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":2048,\"name\":\"stop\",\"url\":\"interfaces/startStop.StartStop.html#stop\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":262144,\"name\":\"[running]\",\"url\":\"interfaces/startStop.StartStop.html#_running_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":262144,\"name\":\"[status]\",\"url\":\"interfaces/startStop.StartStop.html#_status_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":1024,\"name\":\"[initLock]\",\"url\":\"interfaces/startStop.StartStop.html#_initLock_\",\"classes\":\"\",\"parent\":\"startStop.StartStop\"},{\"kind\":64,\"name\":\"ready\",\"url\":\"functions/startStop.ready.html\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"functions/startStop.ready.html#ready.__type\",\"classes\":\"\",\"parent\":\"startStop.ready.ready\"},{\"kind\":8388608,\"name\":\"running\",\"url\":\"modules/startStop.html#running\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules/startStop.html#status\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules/startStop.html#initLock\",\"classes\":\"\",\"parent\":\"startStop\"},{\"kind\":4,\"name\":\"events\",\"url\":\"modules/events.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"EventAsyncInit\",\"url\":\"classes/events.EventAsyncInit.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitStart\",\"url\":\"classes/events.EventAsyncInitStart.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitStarted\",\"url\":\"classes/events.EventAsyncInitStarted.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitStop\",\"url\":\"classes/events.EventAsyncInitStop.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitStopped\",\"url\":\"classes/events.EventAsyncInitStopped.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitDestroy\",\"url\":\"classes/events.EventAsyncInitDestroy.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":128,\"name\":\"EventAsyncInitDestroyed\",\"url\":\"classes/events.EventAsyncInitDestroyed.html\",\"classes\":\"\",\"parent\":\"events\"},{\"kind\":4,\"name\":\"errors\",\"url\":\"modules/errors.html\",\"classes\":\"\"},{\"kind\":128,\"name\":\"ErrorAsyncInit\",\"url\":\"classes/errors.ErrorAsyncInit.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInit.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInit\"},{\"kind\":128,\"name\":\"ErrorAsyncInitRunning\",\"url\":\"classes/errors.ErrorAsyncInitRunning.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitRunning.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitRunning\"},{\"kind\":128,\"name\":\"ErrorAsyncInitNotRunning\",\"url\":\"classes/errors.ErrorAsyncInitNotRunning.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitNotRunning.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitNotRunning\"},{\"kind\":128,\"name\":\"ErrorAsyncInitDestroyed\",\"url\":\"classes/errors.ErrorAsyncInitDestroyed.html\",\"classes\":\"\",\"parent\":\"errors\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"classes/errors.ErrorAsyncInitDestroyed.html#description\",\"classes\":\"\",\"parent\":\"errors.ErrorAsyncInitDestroyed\"},{\"kind\":8388608,\"name\":\"running\",\"url\":\"modules.html#running\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"destroyed\",\"url\":\"modules.html#destroyed\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"status\",\"url\":\"modules.html#status\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"initLock\",\"url\":\"modules.html#initLock\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,38.85]],[\"comment/0\",[]],[\"name/1\",[1,21.504]],[\"comment/1\",[]],[\"name/2\",[2,38.85]],[\"comment/2\",[]],[\"name/3\",[3,22.756]],[\"comment/3\",[]],[\"name/4\",[4,30.377]],[\"comment/4\",[]],[\"name/5\",[4,30.377]],[\"comment/5\",[]],[\"name/6\",[3,22.756]],[\"comment/6\",[]],[\"name/7\",[4,30.377]],[\"comment/7\",[]],[\"name/8\",[5,30.377]],[\"comment/8\",[]],[\"name/9\",[6,33.742]],[\"comment/9\",[]],[\"name/10\",[7,33.742]],[\"comment/10\",[]],[\"name/11\",[8,33.742]],[\"comment/11\",[]],[\"name/12\",[9,25.857]],[\"comment/12\",[]],[\"name/13\",[10,25.857]],[\"comment/13\",[]],[\"name/14\",[1,21.504]],[\"comment/14\",[]],[\"name/15\",[11,22.756]],[\"comment/15\",[]],[\"name/16\",[12,30.377]],[\"comment/16\",[]],[\"name/17\",[3,22.756]],[\"comment/17\",[]],[\"name/18\",[9,25.857]],[\"comment/18\",[]],[\"name/19\",[10,25.857]],[\"comment/19\",[]],[\"name/20\",[1,21.504]],[\"comment/20\",[]],[\"name/21\",[11,22.756]],[\"comment/21\",[]],[\"name/22\",[13,30.377]],[\"comment/22\",[]],[\"name/23\",[13,30.377]],[\"comment/23\",[]],[\"name/24\",[3,22.756]],[\"comment/24\",[]],[\"name/25\",[13,30.377]],[\"comment/25\",[]],[\"name/26\",[5,30.377]],[\"comment/26\",[]],[\"name/27\",[8,33.742]],[\"comment/27\",[]],[\"name/28\",[10,25.857]],[\"comment/28\",[]],[\"name/29\",[1,21.504]],[\"comment/29\",[]],[\"name/30\",[11,22.756]],[\"comment/30\",[]],[\"name/31\",[12,30.377]],[\"comment/31\",[]],[\"name/32\",[3,22.756]],[\"comment/32\",[]],[\"name/33\",[10,25.857]],[\"comment/33\",[]],[\"name/34\",[1,21.504]],[\"comment/34\",[]],[\"name/35\",[11,22.756]],[\"comment/35\",[]],[\"name/36\",[14,30.377]],[\"comment/36\",[]],[\"name/37\",[14,30.377]],[\"comment/37\",[]],[\"name/38\",[3,22.756]],[\"comment/38\",[]],[\"name/39\",[14,30.377]],[\"comment/39\",[]],[\"name/40\",[5,30.377]],[\"comment/40\",[]],[\"name/41\",[6,33.742]],[\"comment/41\",[]],[\"name/42\",[7,33.742]],[\"comment/42\",[]],[\"name/43\",[9,25.857]],[\"comment/43\",[]],[\"name/44\",[1,21.504]],[\"comment/44\",[]],[\"name/45\",[11,22.756]],[\"comment/45\",[]],[\"name/46\",[12,30.377]],[\"comment/46\",[]],[\"name/47\",[3,22.756]],[\"comment/47\",[]],[\"name/48\",[9,25.857]],[\"comment/48\",[]],[\"name/49\",[1,21.504]],[\"comment/49\",[]],[\"name/50\",[11,22.756]],[\"comment/50\",[]],[\"name/51\",[15,38.85]],[\"comment/51\",[]],[\"name/52\",[16,38.85]],[\"comment/52\",[]],[\"name/53\",[17,38.85]],[\"comment/53\",[]],[\"name/54\",[18,38.85]],[\"comment/54\",[]],[\"name/55\",[19,38.85]],[\"comment/55\",[]],[\"name/56\",[20,38.85]],[\"comment/56\",[]],[\"name/57\",[21,38.85]],[\"comment/57\",[]],[\"name/58\",[22,38.85]],[\"comment/58\",[]],[\"name/59\",[23,38.85]],[\"comment/59\",[]],[\"name/60\",[24,38.85]],[\"comment/60\",[]],[\"name/61\",[25,27.864]],[\"comment/61\",[]],[\"name/62\",[26,38.85]],[\"comment/62\",[]],[\"name/63\",[25,27.864]],[\"comment/63\",[]],[\"name/64\",[27,38.85]],[\"comment/64\",[]],[\"name/65\",[25,27.864]],[\"comment/65\",[]],[\"name/66\",[28,38.85]],[\"comment/66\",[]],[\"name/67\",[25,27.864]],[\"comment/67\",[]],[\"name/68\",[9,25.857]],[\"comment/68\",[]],[\"name/69\",[10,25.857]],[\"comment/69\",[]],[\"name/70\",[1,21.504]],[\"comment/70\",[]],[\"name/71\",[11,22.756]],[\"comment/71\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":3,\"name\":{\"3\":{},\"6\":{},\"17\":{},\"24\":{},\"32\":{},\"38\":{},\"47\":{}},\"comment\":{}}],[\"class\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":5,\"name\":{\"8\":{},\"26\":{},\"40\":{}},\"comment\":{}}],[\"createdestroy\",{\"_index\":13,\"name\":{\"22\":{},\"23\":{},\"25\":{}},\"comment\":{}}],[\"createdestroystartstop\",{\"_index\":4,\"name\":{\"4\":{},\"5\":{},\"7\":{}},\"comment\":{}}],[\"description\",{\"_index\":25,\"name\":{\"61\":{},\"63\":{},\"65\":{},\"67\":{}},\"comment\":{}}],[\"destroy\",{\"_index\":8,\"name\":{\"11\":{},\"27\":{}},\"comment\":{}}],[\"destroyed\",{\"_index\":10,\"name\":{\"13\":{},\"19\":{},\"28\":{},\"33\":{},\"69\":{}},\"comment\":{}}],[\"errorasyncinit\",{\"_index\":24,\"name\":{\"60\":{}},\"comment\":{}}],[\"errorasyncinitdestroyed\",{\"_index\":28,\"name\":{\"66\":{}},\"comment\":{}}],[\"errorasyncinitnotrunning\",{\"_index\":27,\"name\":{\"64\":{}},\"comment\":{}}],[\"errorasyncinitrunning\",{\"_index\":26,\"name\":{\"62\":{}},\"comment\":{}}],[\"errors\",{\"_index\":23,\"name\":{\"59\":{}},\"comment\":{}}],[\"eventasyncinit\",{\"_index\":16,\"name\":{\"52\":{}},\"comment\":{}}],[\"eventasyncinitdestroy\",{\"_index\":21,\"name\":{\"57\":{}},\"comment\":{}}],[\"eventasyncinitdestroyed\",{\"_index\":22,\"name\":{\"58\":{}},\"comment\":{}}],[\"eventasyncinitstart\",{\"_index\":17,\"name\":{\"53\":{}},\"comment\":{}}],[\"eventasyncinitstarted\",{\"_index\":18,\"name\":{\"54\":{}},\"comment\":{}}],[\"eventasyncinitstop\",{\"_index\":19,\"name\":{\"55\":{}},\"comment\":{}}],[\"eventasyncinitstopped\",{\"_index\":20,\"name\":{\"56\":{}},\"comment\":{}}],[\"events\",{\"_index\":15,\"name\":{\"51\":{}},\"comment\":{}}],[\"initlock\",{\"_index\":11,\"name\":{\"15\":{},\"21\":{},\"30\":{},\"35\":{},\"45\":{},\"50\":{},\"71\":{}},\"comment\":{}}],[\"ready\",{\"_index\":12,\"name\":{\"16\":{},\"31\":{},\"46\":{}},\"comment\":{}}],[\"running\",{\"_index\":9,\"name\":{\"12\":{},\"18\":{},\"43\":{},\"48\":{},\"68\":{}},\"comment\":{}}],[\"start\",{\"_index\":6,\"name\":{\"9\":{},\"41\":{}},\"comment\":{}}],[\"startstop\",{\"_index\":14,\"name\":{\"36\":{},\"37\":{},\"39\":{}},\"comment\":{}}],[\"status\",{\"_index\":1,\"name\":{\"1\":{},\"14\":{},\"20\":{},\"29\":{},\"34\":{},\"44\":{},\"49\":{},\"70\":{}},\"comment\":{}}],[\"stop\",{\"_index\":7,\"name\":{\"10\":{},\"42\":{}},\"comment\":{}}],[\"types\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/errors.ErrorAsyncInit.html b/docs/classes/errors.ErrorAsyncInit.html index ec2f907..3afe68e 100644 --- a/docs/classes/errors.ErrorAsyncInit.html +++ b/docs/classes/errors.ErrorAsyncInit.html @@ -309,6 +309,7 @@

ErrorAsyncInitDestroyed
  • ErrorAsyncInitNotRunning
  • ErrorAsyncInitRunning
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/classes/errors.ErrorAsyncInitDestroyed.html b/docs/classes/errors.ErrorAsyncInitDestroyed.html index 347ee49..8afb0c8 100644 --- a/docs/classes/errors.ErrorAsyncInitDestroyed.html +++ b/docs/classes/errors.ErrorAsyncInitDestroyed.html @@ -305,6 +305,7 @@

    ErrorAsyncInitDestroyed
  • ErrorAsyncInitNotRunning
  • ErrorAsyncInitRunning

    • +
  • events
  • startStop
  • types
    • diff --git a/docs/classes/errors.ErrorAsyncInitNotRunning.html b/docs/classes/errors.ErrorAsyncInitNotRunning.html index 4bd768e..c5feffa 100644 --- a/docs/classes/errors.ErrorAsyncInitNotRunning.html +++ b/docs/classes/errors.ErrorAsyncInitNotRunning.html @@ -305,6 +305,7 @@

    ErrorAsyncInitDestroyed
  • ErrorAsyncInitNotRunning
  • ErrorAsyncInitRunning

    • +
  • events
  • startStop
  • types
    • diff --git a/docs/classes/errors.ErrorAsyncInitRunning.html b/docs/classes/errors.ErrorAsyncInitRunning.html index e22eb31..aaa39d3 100644 --- a/docs/classes/errors.ErrorAsyncInitRunning.html +++ b/docs/classes/errors.ErrorAsyncInitRunning.html @@ -305,6 +305,7 @@

    ErrorAsyncInitDestroyed
  • ErrorAsyncInitNotRunning
  • ErrorAsyncInitRunning

    • +
  • events
  • startStop
  • types
    • diff --git a/docs/classes/events.EventAsyncInit.html b/docs/classes/events.EventAsyncInit.html new file mode 100644 index 0000000..50dde0f --- /dev/null +++ b/docs/classes/events.EventAsyncInit.html @@ -0,0 +1,475 @@ +EventAsyncInit | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInit<T>Abstract

    +
    +

    Type Parameters

    +
      +
    • +

      T = null

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Type Parameters

      +
        +
      • +

        T = null

      +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<T>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInit<T>

      • + +
    • +
      +

      Type Parameters

      +
        +
      • +

        T = null

      +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<T>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInit<T>

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: T
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInit<T>

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: T
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitDestroy.html b/docs/classes/events.EventAsyncInitDestroy.html new file mode 100644 index 0000000..3606ae5 --- /dev/null +++ b/docs/classes/events.EventAsyncInitDestroy.html @@ -0,0 +1,453 @@ +EventAsyncInitDestroy | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitDestroy

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitDestroy

      • + +
    • +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitDestroy

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitDestroy

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitDestroyed.html b/docs/classes/events.EventAsyncInitDestroyed.html new file mode 100644 index 0000000..13ea882 --- /dev/null +++ b/docs/classes/events.EventAsyncInitDestroyed.html @@ -0,0 +1,453 @@ +EventAsyncInitDestroyed | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitDestroyed

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitDestroyed

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitStart.html b/docs/classes/events.EventAsyncInitStart.html new file mode 100644 index 0000000..5be3b13 --- /dev/null +++ b/docs/classes/events.EventAsyncInitStart.html @@ -0,0 +1,453 @@ +EventAsyncInitStart | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitStart

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStart

      • + +
    • +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStart

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitStart

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitStarted.html b/docs/classes/events.EventAsyncInitStarted.html new file mode 100644 index 0000000..c0f98d5 --- /dev/null +++ b/docs/classes/events.EventAsyncInitStarted.html @@ -0,0 +1,453 @@ +EventAsyncInitStarted | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitStarted

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStarted

      • + +
    • +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStarted

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitStarted

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitStop.html b/docs/classes/events.EventAsyncInitStop.html new file mode 100644 index 0000000..300757a --- /dev/null +++ b/docs/classes/events.EventAsyncInitStop.html @@ -0,0 +1,453 @@ +EventAsyncInitStop | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitStop

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStop

      • + +
    • +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStop

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitStop

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/classes/events.EventAsyncInitStopped.html b/docs/classes/events.EventAsyncInitStopped.html new file mode 100644 index 0000000..513182a --- /dev/null +++ b/docs/classes/events.EventAsyncInitStopped.html @@ -0,0 +1,453 @@ +EventAsyncInitStopped | @matrixai/async-init
    +
    + +
    +
    +
    +
    + +

    Class EventAsyncInitStopped

    +
    +

    Hierarchy

    +
    +
    +
    +
    + +
    +
    +

    Constructors

    +
    constructor +
    +
    +

    Properties

    +
    AT_TARGET +BUBBLING_PHASE +CAPTURING_PHASE +NONE +bubbles +cancelBubble +cancelable +composed +constructorParams +currentTarget +defaultPrevented +detail +eventPhase +isTrusted +returnValue +srcElement +target +timeStamp +type +
    +
    +

    Methods

    +
    clone +composedPath +initCustomEvent +initEvent +preventDefault +stopImmediatePropagation +stopPropagation +
    +
    +

    Constructors

    +
    +

    constructor

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        Optional type: string
        • +
      • +
        Optional options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStopped

      • + +
    • +
      +

      Parameters

      +
        +
      • +
        options: CustomEventInit<null>
        • +
      • +
        Optional constructorParams: IArguments
      +

      Returns EventAsyncInitStopped

    +
    +

    Properties

    +
    +

    Readonly AT_TARGET

    +
    AT_TARGET: 2
    +
    +

    Readonly BUBBLING_PHASE

    +
    BUBBLING_PHASE: 3
    +
    +

    Readonly CAPTURING_PHASE

    +
    CAPTURING_PHASE: 1
    +
    +

    Readonly NONE

    +
    NONE: 0
    +
    +

    Readonly bubbles

    +
    bubbles: boolean
    +

    Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    cancelBubble

    +
    cancelBubble: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly cancelable

    +
    cancelable: boolean
    +

    Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly composed

    +
    composed: boolean
    +

    Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Protected constructorParams

    +
    constructorParams: IArguments
    +
    +

    Readonly currentTarget

    +
    currentTarget: null | EventTarget
    +

    Returns the object whose event listener's callback is currently being invoked.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly defaultPrevented

    +
    defaultPrevented: boolean
    +

    Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly detail

    +
    detail: null
    +

    Returns any custom data event was created with. Typically used for synthetic events.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly eventPhase

    +
    eventPhase: number
    +

    Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly isTrusted

    +
    isTrusted: boolean
    +

    Returns true if event was dispatched by the user agent, and false otherwise.

    +

    MDN Reference

    +
    +
    +
    +

    returnValue

    +
    returnValue: boolean
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly srcElement

    +
    srcElement: null | EventTarget
    +
    +

    Deprecated

    MDN Reference

    +
    +
    +

    Readonly target

    +
    target: null | EventTarget
    +

    Returns the object to which event is dispatched (its target).

    +

    MDN Reference

    +
    +
    +
    +

    Readonly timeStamp

    +
    timeStamp: number
    +

    Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

    +

    MDN Reference

    +
    +
    +
    +

    Readonly type

    +
    type: string
    +

    Returns the type of event, e.g. "click", "hashchange", or "submit".

    +

    MDN Reference

    +
    +
    +
    +

    Methods

    +
    +

    clone

    +
      + +
    • +

      Events cannot be re-dispatched. This was probably to prevent infinite +loops. So instead of re-dispatching the same instance, we re-dispatch +a clone of the instance.

      +
      +

      Returns EventAsyncInitStopped

      +
    +
    +

    composedPath

    +
      + +
    • +

      Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

      +

      MDN Reference

      +
      +

      Returns EventTarget[]

      +
    +
    +

    initCustomEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
        • +
      • +
        Optional detail: null
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    initEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        Optional bubbles: boolean
        • +
      • +
        Optional cancelable: boolean
      +

      Returns void

      +
      +

      Deprecated

      MDN Reference

      +
    +
    +

    preventDefault

    +
      + +
    • +

      If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopImmediatePropagation

    +
      + +
    • +

      Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +

    stopPropagation

    +
      + +
    • +

      When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

      +

      MDN Reference

      +
      +

      Returns void

      +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +

    On This Page

     +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/functions/createDestroy.CreateDestroy-1.html b/docs/functions/createDestroy.CreateDestroy-1.html index 5337d6f..99b3dff 100644 --- a/docs/functions/createDestroy.CreateDestroy-1.html +++ b/docs/functions/createDestroy.CreateDestroy-1.html @@ -18,18 +18,28 @@

    Function CreateDestroy

      - +

    • Type Parameters

      • DestroyReturn = unknown

      -

      Returns (<T>(constructor) => {
          prototype: __type<any, any>;
          new (...args): __type<DestroyReturn, T>;
      } & T)

      +
      +

      Parameters

      +
        +
      • +
        __namedParameters: {
            eventDestroy?: Class<Event>;
            eventDestroyed?: Class<Event>;
        } = {}
        +
          +
        • +
          Optional eventDestroy?: Class<Event>
          • +
        • +
          Optional eventDestroyed?: Class<Event>
      +

      Returns (<T>(constructor) => (new (...args) => createDestroy.CreateDestroy<DestroyReturn>) & T)

        • -
        • <T>(constructor): {
              prototype: __type<any, any>;
              new (...args): __type<DestroyReturn, T>;
          } & T
          • +
        • <T>(constructor): (new (...args) => createDestroy.CreateDestroy<DestroyReturn>) & T

        • Type Parameters

          @@ -41,9 +51,9 @@

          Parameters

          • constructor: T
          -

          Returns {
              prototype: __type<any, any>;
              new (...args): __type<DestroyReturn, T>;
          } & T

    +
  • Defined in src/CreateDestroy.ts:25
    • @@ -78,6 +88,7 @@

    Theme

  • createDestroyStartStop
  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/functions/createDestroyStartStop.CreateDestroyStartStop-1.html b/docs/functions/createDestroyStartStop.CreateDestroyStartStop-1.html index 74a2cba..59cd155 100644 --- a/docs/functions/createDestroyStartStop.CreateDestroyStartStop-1.html +++ b/docs/functions/createDestroyStartStop.CreateDestroyStartStop-1.html @@ -18,7 +18,7 @@

    Function CreateDestroyStartStop

      - +

    • Type Parameters

      @@ -35,12 +35,27 @@

      Parameters

    • errorRunning: Error = ...
    • -
      errorDestroyed: Error = ...
    -

    Returns (<T>(constructor) => {
        prototype: __type<any, any, any, any>;
        new (...args): __type<StartReturn, StopReturn, DestroyReturn, T>;
    } & T)

    +
    errorDestroyed: Error = ...
    +
  • +
    __namedParameters: {
        eventDestroy?: Class<Event>;
        eventDestroyed?: Class<Event>;
        eventStart?: Class<Event>;
        eventStarted?: Class<Event>;
        eventStop?: Class<Event>;
        eventStopped?: Class<Event>;
    } = {}
    +
      +
    • +
      Optional eventDestroy?: Class<Event>
      • +
    • +
      Optional eventDestroyed?: Class<Event>
      • +
    • +
      Optional eventStart?: Class<Event>
      • +
    • +
      Optional eventStarted?: Class<Event>
      • +
    • +
      Optional eventStop?: Class<Event>
      • +
    • +
      Optional eventStopped?: Class<Event>
    • +

    Returns (<T>(constructor) => (new (...args) => createDestroyStartStop.CreateDestroyStartStop<StartReturn, StopReturn, DestroyReturn>) & T)

      • -
      • <T>(constructor): {
            prototype: __type<any, any, any, any>;
            new (...args): __type<StartReturn, StopReturn, DestroyReturn, T>;
        } & T
        • +
      • <T>(constructor): (new (...args) => createDestroyStartStop.CreateDestroyStartStop<StartReturn, StopReturn, DestroyReturn>) & T

      • Type Parameters

        @@ -52,9 +67,9 @@

        Parameters

        • constructor: T
        -

        Returns {
            prototype: __type<any, any, any, any>;
            new (...args): __type<StartReturn, StopReturn, DestroyReturn, T>;
        } & T

    +
  • Defined in src/CreateDestroyStartStop.ts:45
    • @@ -90,6 +105,7 @@

    Theme

  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/functions/startStop.StartStop-1.html b/docs/functions/startStop.StartStop-1.html index d17838f..917ab3e 100644 --- a/docs/functions/startStop.StartStop-1.html +++ b/docs/functions/startStop.StartStop-1.html @@ -18,7 +18,7 @@

    Function StartStop

      - +

    • Type Parameters

      @@ -27,11 +27,25 @@

      Type Parameters

      StartReturn = unknown

    • StopReturn = unknown

    -

    Returns (<T>(constructor) => {
        prototype: __type<any, any, any>;
        new (...args): __type<StartReturn, StopReturn, T>;
    } & T)

    +
    +

    Parameters

    +
    +

    Returns (<T>(constructor) => (new (...args) => startStop.StartStop<StartReturn, StopReturn>) & T)

    @@ -71,6 +85,7 @@

    Theme

    diff --git a/docs/interfaces/createDestroy.CreateDestroy.html b/docs/interfaces/createDestroy.CreateDestroy.html index ebc8f9e..72f1041 100644 --- a/docs/interfaces/createDestroy.CreateDestroy.html +++ b/docs/interfaces/createDestroy.CreateDestroy.html @@ -24,10 +24,12 @@

    DestroyReturn =

    Hierarchy

      -
    • CreateDestroy
    @@ -35,7 +37,7 @@

    Constructors

    -
    +

    constructor

    -
    constructor
    +
    constructor

    Properties

    Readonly [initLock]

    [initLock]: RWLockWriter
    +
  • Defined in src/CreateDestroy.ts:21

    • Accessors

    @@ -71,7 +80,34 @@

    [destroyed]

    Returns boolean

    +
  • Defined in src/CreateDestroy.ts:19
    • +
    +

    [eventHandled]

    +
    +
    +

    [eventHandlers]

    +
    +
    +

    [eventTarget]

    +

    [status]

    +
  • Defined in src/CreateDestroy.ts:20

    • Methods

    +
    +

    addEventListener

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        callback: null | EventListenerOrEventListenerObject
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
      +

      Returns void

    destroy

      @@ -94,7 +148,39 @@

      Parameters

      Rest ...args: any[]

    Returns Promise<void | DestroyReturn>

    +
  • Defined in src/CreateDestroy.ts:22
    • +
    +

    dispatchEvent

    +
    +
    +

    removeEventListener

    +
    @@ -114,11 +200,17 @@

    Theme

    @@ -183,6 +275,7 @@

    CreateDestroyStartStop
  • ready

  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/interfaces/startStop.StartStop.html b/docs/interfaces/startStop.StartStop.html index a61dec5..e3e8377 100644 --- a/docs/interfaces/startStop.StartStop.html +++ b/docs/interfaces/startStop.StartStop.html @@ -26,10 +26,12 @@

    StopReturn =

    Hierarchy

      -
    • StartStop
    @@ -37,7 +39,7 @@

    Accessors

    -
    [running] +
    [eventHandled] +[eventHandlers] +[eventTarget] +[running] [status]

    Methods

    -
    start +
    addEventListener +dispatchEvent +removeEventListener +start stop

    Constructors

    -
    +

    constructor

    -
    constructor
    +
    constructor

    Properties

    Readonly [initLock]

    [initLock]: RWLockWriter
    +
  • Defined in src/StartStop.ts:27

    • Accessors

    +
    +

    [eventHandled]

    +
      +
    • get [eventHandled](): WeakSet<Event>
      • +
    • +

      Returns WeakSet<Event>

    +
    +

    [eventHandlers]

    +
      +
    • get [eventHandlers](): WeakMap<EventListenerOrEventListenerObject, EventListener>
      • +
    • +

      Returns WeakMap<EventListenerOrEventListenerObject, EventListener>

    +
    +

    [eventTarget]

    +
      +
    • get [eventTarget](): EventTarget
      • +
    • +

      Returns EventTarget

    [running]

    +
  • Defined in src/StartStop.ts:25

    • [status]

    +
  • Defined in src/StartStop.ts:26

    • Methods

    +
    +

    addEventListener

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        callback: null | EventListenerOrEventListenerObject
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
      +

      Returns void

    +
    +

    dispatchEvent

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        event: Event
      +

      Returns boolean

    +
    +

    removeEventListener

    +
      + +
    • +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        callback: null | EventListenerOrEventListenerObject
        • +
      • +
        Optional options: boolean | EventListenerOptions
      +

      Returns void

    start

      @@ -97,7 +183,7 @@

      Parameters

      Rest ...args: any[]

    Returns Promise<void | StartReturn>

    +
  • Defined in src/StartStop.ts:28

    • stop

    Returns Promise<void | StopReturn>

    +
  • Defined in src/StartStop.ts:29
    • @@ -130,10 +216,16 @@

    Theme

  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/modules/errors.html b/docs/modules/errors.html index 33c170a..53b21bd 100644 --- a/docs/modules/errors.html +++ b/docs/modules/errors.html @@ -59,6 +59,7 @@

    Theme

    +
    +
    +@matrixai/async-init +
    +
    +
    +
    + +

    Namespace events

    +
    +
    +

    Index

    +
    +

    Classes

    +
    EventAsyncInit +EventAsyncInitDestroy +EventAsyncInitDestroyed +EventAsyncInitStart +EventAsyncInitStarted +EventAsyncInitStop +EventAsyncInitStopped +
    +
    +
    +
    +
    +

    Settings

     +
    +
    +

    Member Visibility

    +
      +
      • +
      • +
      • +
    +
    +

    Theme

    +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/docs/modules/startStop.html b/docs/modules/startStop.html index d5ce8af..7bbbf35 100644 --- a/docs/modules/startStop.html +++ b/docs/modules/startStop.html @@ -77,6 +77,7 @@

    createDestroy
  • createDestroyStartStop
  • errors
    • +
  • events
  • startStop
    diff --git a/docs/modules/types.html b/docs/modules/types.html index 03397c2..3b157e4 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -22,7 +22,8 @@

    Namespace types

  • ready
  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/variables/createDestroyStartStop.initLock.html b/docs/variables/createDestroyStartStop.initLock.html index 69d271d..79c2a49 100644 --- a/docs/variables/createDestroyStartStop.initLock.html +++ b/docs/variables/createDestroyStartStop.initLock.html @@ -54,6 +54,7 @@

    Theme

  • errors
    • +
  • events
  • startStop
  • types
    • diff --git a/docs/variables/createDestroyStartStop.status.html b/docs/variables/createDestroyStartStop.status.html index 086f142..b1a0e99 100644 --- a/docs/variables/createDestroyStartStop.status.html +++ b/docs/variables/createDestroyStartStop.status.html @@ -54,6 +54,7 @@

    Theme

    +
  • Defined in src/events.ts:1

    • Index

    @@ -52,6 +52,7 @@

    Theme