fraport/fradrive
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add documentation to js util »setup«

Browse Source
This commit is contained in:
Felix Hamann 2019-02-19 23:26:24 +01:00
parent b65b44bf8a
commit 99394bf166
1 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
static/js/utils/setup.js
View File

@ -5,9 +5,16 @@
var registeredSetupListeners = {};
window.utils.setup = function(utilType, scope, options) {
/**
* setup function to initiate a util (utilName) on a scope (sope) with options (options).
*
* A util has to define an itself at `window.utils` as shown for the `autoSubmit` util:
* `window.utils.autoSubmit = function(wrapper, options) { ... };`
*/
if (!utilType || !scope) {
window.utils.setup = function(utilName, scope, options) {
if (!utilName || !scope) {
return;
}
@ -15,44 +22,44 @@
var listener = function(event) {
if (event.detail.targetUtil !== utilType) {
if (event.detail.targetUtil !== utilName) {
return false;
}
if (options.setupFunction) {
options.setupFunction(scope, options);
} else {
var util = window.utils[utilType];
var util = window.utils[utilName];
if (!util) {
throw new Error('"' + utilType + '" is not a known js util');
throw new Error('"' + utilName + '" is not a known js util');
}
util(scope, options);
}
};
if (registeredSetupListeners[utilType] && !options.singleton) {
registeredSetupListeners[utilType].push(listener);
if (registeredSetupListeners[utilName] && !options.singleton) {
registeredSetupListeners[utilName].push(listener);
} else {
window.utils.teardown(utilType);
registeredSetupListeners[utilType] = [ listener ];
window.utils.teardown(utilName);
registeredSetupListeners[utilName] = [ listener ];
}
document.addEventListener('setup', listener);
document.dispatchEvent(new CustomEvent('setup', {
detail: { targetUtil: utilType, module: 'none' },
detail: { targetUtil: utilName, module: 'none' },
bubbles: true,
cancelable: true,
}));
};
window.utils.teardown = function(utilType) {
if (registeredSetupListeners[utilType]) {
registeredSetupListeners[utilType].forEach(function(listener) {
window.utils.teardown = function(utilName) {
if (registeredSetupListeners[utilName]) {
registeredSetupListeners[utilName].forEach(function(listener) {
document.removeEventListener('setup', listener);
});
delete registeredSetupListeners[utilType];
delete registeredSetupListeners[utilName];
}
}
})();