diff options
Diffstat (limited to 'packages/vold-utils/docs/unload+.md')
| -rw-r--r-- | packages/vold-utils/docs/unload+.md | 20 |
1 files changed, 0 insertions, 20 deletions
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> |