mirror of
https://github.com/Karaka-Management/jsOMS.git
synced 2026-01-11 17:58:41 +00:00
improve docblocks
This commit is contained in:
parent
7a43f8f11e
commit
8da3803651
|
|
@ -1,8 +1,8 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Append datalist element.
|
||||
*
|
||||
* @param {{id:string},{data:object},{text:string},{value:string}} action Message data
|
||||
* @param {function} callback Callback
|
||||
* @param {{id:string},{data:object},{text:string},{value:string}} action Message data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Clear datalist.
|
||||
*
|
||||
* @param {{id:string}} action Message data
|
||||
* @param {function} callback Callback
|
||||
* @param {{id:string}} action Message data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
/**
|
||||
* Focus an element.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export function focusAction (action, callback)
|
||||
{
|
||||
"use strict";
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Get value from dom.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
/**
|
||||
* Hide an element.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export function hideAction (action, callback)
|
||||
{
|
||||
"use strict";
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Show popup.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {id} element Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Reload dom.
|
||||
* Reload page.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Remove dom element.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Remove value from input.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Set value of input.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {id} element Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,4 +1,13 @@
|
|||
export function showAction (action, callback)
|
||||
/**
|
||||
* Show dom element.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export function showAction (action, callback, id)
|
||||
{
|
||||
"use strict";
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Apped element to a table.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Clear table.
|
||||
*
|
||||
* @param {{id:string}} action Message data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
/**
|
||||
* Prevent UI action.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,12 +1,13 @@
|
|||
/**
|
||||
* Log.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
* @param {string} id Action element
|
||||
*
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export function logAction (action, callback)
|
||||
export function logAction (action, callback, id)
|
||||
{
|
||||
"use strict";
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
import { Request } from '../../../Message/Request/Request.js';
|
||||
|
||||
|
||||
/**
|
||||
* Set message.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* Collect data.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Set timer for next action.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
/**
|
||||
* Validate Keypress.
|
||||
* Validate keypress.
|
||||
*
|
||||
* @param {Object} action Action data
|
||||
* @param {Object} action Action data
|
||||
* @param {function} callback Callback
|
||||
*
|
||||
* @since 1.0.0
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
/**
|
||||
* DOM action type.
|
||||
*
|
||||
* @copyright Dennis Eichhorn
|
||||
* @license OMS License 1.0
|
||||
* @version 1.0.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export const EnumDomActionType = Object.freeze({
|
||||
CREATE_BEFORE: 0,
|
||||
CREATE_AFTER: 1,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Form validation.
|
||||
*
|
||||
* @param {{delay:int},{errors:string},{form:string}} data Message data
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Notification message.
|
||||
*
|
||||
* @param {{title:string},{content:string},{level:int},{delay:int},{stay:int}} data Message data
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,11 @@
|
|||
/**
|
||||
* Notification type.
|
||||
*
|
||||
* @copyright Dennis Eichhorn
|
||||
* @license OMS License 1.0
|
||||
* @version 1.0.0
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export const EnumNotifyType = Object.freeze({
|
||||
BINARY: 0,
|
||||
INFO: 1,
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
import { UriFactory } from '../../Uri/UriFactory.js';
|
||||
|
||||
/**
|
||||
* Set message.
|
||||
* Redirect.
|
||||
*
|
||||
* @param {{delay:int},{uri:string}} data Message data
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/**
|
||||
* Set message.
|
||||
* Reload page.
|
||||
*
|
||||
* @param {{delay:int}} data Message data
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user