Skip to content

Commit 4c6ab53

Browse files
committed
Update API docs for Application protocols
1 parent 14d937b commit 4c6ab53

File tree

3 files changed

+121
-32
lines changed

3 files changed

+121
-32
lines changed

doc/index.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
3-
<html><head><meta charset="UTF-8" /><title> </title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="moira.application.html"><div class="inner"><span>moira.application</span></div></a></li><li class="depth-1 "><a href="moira.context.html"><div class="inner"><span>moira.context</span></div></a></li><li class="depth-1 "><a href="moira.event.html"><div class="inner"><span>moira.event</span></div></a></li><li class="depth-1 "><a href="moira.log.event-emitter.html"><div class="inner"><span>moira.log.event-emitter</span></div></a></li><li class="depth-1 "><a href="moira.log.module.html"><div class="inner"><span>moira.log.module</span></div></a></li><li class="depth-1 "><a href="moira.log.txs.html"><div class="inner"><span>moira.log.txs</span></div></a></li><li class="depth-1 "><a href="moira.module.html"><div class="inner"><span>moira.module</span></div></a></li><li class="depth-1 "><a href="moira.transition.html"><div class="inner"><span>moira.transition</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></h1><h2>Namespaces</h2><div class="namespace"><h3><a href="moira.application.html">moira.application</a></h3><div class="doc"><pre class="plaintext">Configure module dependencies, manage module lifecycles, and set up
4-
the unified application log for inter-module communication.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.application.html#var-*timeout*">*timeout*</a> </li><li> <a href="moira.application.html#var-*warnings.3F*">*warnings?*</a> </li><li> <a href="moira.application.html#var-Application">Application</a> </li><li> <a href="moira.application.html#var-Chainable">Chainable</a> </li><li> <a href="moira.application.html#var-create">create</a> </li><li> <a href="moira.application.html#var-Extendable">Extendable</a> </li><li> <a href="moira.application.html#var-init.21">init!</a> </li><li> <a href="moira.application.html#var-load.21">load!</a> </li><li> <a href="moira.application.html#var-pause.21">pause!</a> </li><li> <a href="moira.application.html#var-resume.21">resume!</a> </li><li> <a href="moira.application.html#var-start.21">start!</a> </li><li> <a href="moira.application.html#var-stop.21">stop!</a> </li><li> <a href="moira.application.html#var-Thenable">Thenable</a> </li><li> <a href="moira.application.html#var-Transitionable">Transitionable</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.context.html">moira.context</a></h3><div class="doc"><pre class="plaintext">Implementation of the interceptor pattern based on an asynchronous promise
3+
<html><head><meta charset="UTF-8" /><title> </title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1 "><a href="moira.application.html"><div class="inner"><span>moira.application</span></div></a></li><li class="depth-1 "><a href="moira.context.html"><div class="inner"><span>moira.context</span></div></a></li><li class="depth-1 "><a href="moira.event.html"><div class="inner"><span>moira.event</span></div></a></li><li class="depth-1 "><a href="moira.log.event-emitter.html"><div class="inner"><span>moira.log.event-emitter</span></div></a></li><li class="depth-1 "><a href="moira.log.module.html"><div class="inner"><span>moira.log.module</span></div></a></li><li class="depth-1 "><a href="moira.log.txs.html"><div class="inner"><span>moira.log.txs</span></div></a></li><li class="depth-1 "><a href="moira.module.html"><div class="inner"><span>moira.module</span></div></a></li><li class="depth-1 "><a href="moira.transition.html"><div class="inner"><span>moira.transition</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></h1><h2>Namespaces</h2><div class="namespace"><h3><a href="moira.application.html">moira.application</a></h3><div class="doc"><pre class="plaintext">Instrument modules and their dependencies by wrapping `system-map` with an
4+
instance of `Application`. When system lifecycle events such as `start!`,
5+
`stop!`, `pause!`, or `resume!` are triggered, the corresponding state
6+
`transition` executes on each module and its dependencies in order.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.application.html#var-*timeout*">*timeout*</a> </li><li> <a href="moira.application.html#var-*warnings.3F*">*warnings?*</a> </li><li> <a href="moira.application.html#var-Application">Application</a> </li><li> <a href="moira.application.html#var-Chainable">Chainable</a> </li><li> <a href="moira.application.html#var-create">create</a> </li><li> <a href="moira.application.html#var-Extendable">Extendable</a> </li><li> <a href="moira.application.html#var-init.21">init!</a> </li><li> <a href="moira.application.html#var-load.21">load!</a> </li><li> <a href="moira.application.html#var-pause.21">pause!</a> </li><li> <a href="moira.application.html#var-resume.21">resume!</a> </li><li> <a href="moira.application.html#var-start.21">start!</a> </li><li> <a href="moira.application.html#var-stop.21">stop!</a> </li><li> <a href="moira.application.html#var-Thenable">Thenable</a> </li><li> <a href="moira.application.html#var-Transitionable">Transitionable</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.context.html">moira.context</a></h3><div class="doc"><pre class="plaintext">Implementation of the interceptor pattern based on an asynchronous promise
57
chain.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.context.html#var--.3Eex">-&gt;ex</a> </li><li> <a href="moira.context.html#var-done.3F">done?</a> </li><li> <a href="moira.context.html#var-emit">emit</a> </li><li> <a href="moira.context.html#var-enqueue">enqueue</a> </li><li> <a href="moira.context.html#var-enter-1">enter-1</a> </li><li> <a href="moira.context.html#var-error.3F">error?</a> </li><li> <a href="moira.context.html#var-execute">execute</a> </li><li> <a href="moira.context.html#var-execute-1">execute-1</a> </li><li> <a href="moira.context.html#var-execute-all">execute-all</a> </li><li> <a href="moira.context.html#var-into-queue">into-queue</a> </li><li> <a href="moira.context.html#var-into-stack">into-stack</a> </li><li> <a href="moira.context.html#var-leave-1">leave-1</a> </li><li> <a href="moira.context.html#var-queue.3F">queue?</a> </li><li> <a href="moira.context.html#var-stack">stack</a> </li><li> <a href="moira.context.html#var-terminate">terminate</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.event.html">moira.event</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.event.html#var-app-id">app-id</a> </li><li> <a href="moira.event.html#var-counter-.3Esuffix">counter-&gt;suffix</a> </li><li> <a href="moira.event.html#var-current-date">current-date</a> </li><li> <a href="moira.event.html#var-date-.3Eprefix">date-&gt;prefix</a> </li><li> <a href="moira.event.html#var-event-id.3F">event-id?</a> </li><li> <a href="moira.event.html#var-EventFactory">EventFactory</a> </li><li> <a href="moira.event.html#var-EventIdGenerator">EventIdGenerator</a> </li><li> <a href="moira.event.html#var-Factory">Factory</a> </li><li> <a href="moira.event.html#var-factory">factory</a> </li><li> <a href="moira.event.html#var-IdGenerator">IdGenerator</a> </li><li> <a href="moira.event.html#var-monotonic-now">monotonic-now</a> </li><li> <a href="moira.event.html#var-string-.3Eevent-id">string-&gt;event-id</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.log.event-emitter.html">moira.log.event-emitter</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.log.event-emitter.html#var-create">create</a> </li><li> <a href="moira.log.event-emitter.html#var-EventEmitter">EventEmitter</a> </li><li> <a href="moira.log.event-emitter.html#var-Listenable">Listenable</a> </li><li> <a href="moira.log.event-emitter.html#var-Resumable">Resumable</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.log.module.html">moira.log.module</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.log.module.html#var-default">default</a> </li><li> <a href="moira.log.module.html#var-export">export</a> </li><li> <a href="moira.log.module.html#var-start">start</a> </li><li> <a href="moira.log.module.html#var-stop">stop</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.log.txs.html">moira.log.txs</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.log.txs.html#var-ensure-dependency">ensure-dependency</a> </li><li> <a href="moira.log.txs.html#var-inject">inject</a> </li><li> <a href="moira.log.txs.html#var-pause">pause</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.module.html">moira.module</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.module.html#var-dependency-chain">dependency-chain</a> </li><li> <a href="moira.module.html#var-enter">enter</a> </li><li> <a href="moira.module.html#var-ex-cyclic-deps.3F">ex-cyclic-deps?</a> </li><li> <a href="moira.module.html#var-execute">execute</a> </li><li> <a href="moira.module.html#var-exit">exit</a> </li><li> <a href="moira.module.html#var-only">only</a> </li><li> <a href="moira.module.html#var-postwalk-deps">postwalk-deps</a> </li><li> <a href="moira.module.html#var-step">step</a> </li><li> <a href="moira.module.html#var-terminate">terminate</a> </li><li> <a href="moira.module.html#var-with-plugins">with-plugins</a> </li></ul></div></div><div class="namespace"><h3><a href="moira.transition.html">moira.transition</a></h3><div class="doc"><pre class="plaintext"></pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="moira.transition.html#var-all.3F">all?</a> </li><li> <a href="moira.transition.html#var-down">down</a> </li><li> <a href="moira.transition.html#var-enqueue-modules">enqueue-modules</a> </li><li> <a href="moira.transition.html#var-enqueue-modules-with-deps">enqueue-modules-with-deps</a> </li><li> <a href="moira.transition.html#var-execute">execute</a> </li><li> <a href="moira.transition.html#var-execute-txs">execute-txs</a> </li><li> <a href="moira.transition.html#var-execute-txs-1">execute-txs-1</a> </li><li> <a href="moira.transition.html#var-reverse-modules">reverse-modules</a> </li><li> <a href="moira.transition.html#var-tx">tx</a> </li><li> <a href="moira.transition.html#var-up">up</a> </li></ul></div></div></div></body></html>

0 commit comments

Comments
 (0)