aboutsummaryrefslogtreecommitdiffstats
path: root/packages/vold-utils/docs
diff options
context:
space:
mode:
Diffstat (limited to 'packages/vold-utils/docs')
-rw-r--r--packages/vold-utils/docs/listen.md23
-rw-r--r--packages/vold-utils/docs/unload+.md20
2 files changed, 0 insertions, 43 deletions
diff --git a/packages/vold-utils/docs/listen.md b/packages/vold-utils/docs/listen.md
deleted file mode 100644
index d19c6c6..0000000
--- a/packages/vold-utils/docs/listen.md
+++ /dev/null
@@ -1,23 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `listen` module allows modules to register listeners to elements that are
-automatically removed when the module unloads.
-
-<api name="listen">
-@function
- Add listeners to run when unloading in a unload queue. Optionally scope the
- callback to a container, e.g., window. Provide a way to run all the callbacks.
-
-@param container {object}
- A container for the node, which a "unload" event will be attached to, this is
- used to cancel the unload magic that would occur, to avoid memory leaks.
-@param node {object}
- The node to listen to.
-@param event {string}
- The event type, for example: "load", "click", ...
-@param callback {function}
- A function to be called when the event occurs on the node.
-@param [capture] {boolean}
- Indicates if the event should be captured. [See the `useCapture`
- documentation here](https://developer.mozilla.org/en/DOM/element.addEventListener).
-</api>
diff --git a/packages/vold-utils/docs/unload+.md b/packages/vold-utils/docs/unload+.md
deleted file mode 100644
index 78693ef..0000000
--- a/packages/vold-utils/docs/unload+.md
+++ /dev/null
@@ -1,20 +0,0 @@
-<!-- contributed by Erik Vold [erikvvold@gmail.com] -->
-
-The `unload+` module allows modules to register callbacks that are called
-when they are unloaded, and associate unload functions to containers to have the
-unloader automatically deleted when the container unloads.
-
-<api name="unload">
-@function
- Save callbacks to run when unloading in a unload queue. Optionally scope the
- callback to a container, e.g., window. Provide a way to run all the callbacks.
-
-@param callback {function}
- A function to be called when the module unloads.
-@param [container] {object}
- Optional container object; if the container "unloads" before the module
- unloads, then the associated callback is removed from the unload queue.
-@returns {function}
- Returns a function which will allow one to remove the callback from the unload
- queue.
-</api>