UNPKG

@base-framework/atoms

Version:

This will add default atoms to the base framework.

280 lines (279 loc) 6.4 kB
export function getParentData(parent: object): object | null; /** * This will create an on data tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function On(data: object, prop: string, callBack: Function): any; /** * This will create an on data tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function On(prop: string, callBack: Function): object; /** * This will create an on state tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function OnState(data: object, prop: string, callBack: Function): any; /** * This will create an on state tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function OnState(prop: string, callBack: Function): object; /** * This will create an on route tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function OnRoute(data: object, prop: string, callBack: Function): any; /** * This will create an on route tag. * * @overload * @param {object} data * @param {string} prop * @param {function} callBack * * @overload * @param {string} prop * @param {function} callBack * * @returns {object} */ export function OnRoute(prop: string, callBack: Function): object; /** * This will create an if data tag. * * @overload * @param {object} data * @param {string} prop * @param {*} value * @param {function} callBack * * @overload * @param {string} prop * @param {*} value * @param {function} callBack * * @returns {object} */ export function If(data: object, prop: string, value: any, callBack: Function): any; /** * This will create an if data tag. * * @overload * @param {object} data * @param {string} prop * @param {*} value * @param {function} callBack * * @overload * @param {string} prop * @param {*} value * @param {function} callBack * * @returns {object} */ export function If(prop: string, value: any, callBack: Function): object; /** * This will create an if state tag. * * @overload * @param {object} data * @param {string} prop * @param {*} value * @param {function} callBack * * @overload * @param {string} prop * @param {*} value * @param {function} callBack * * @returns {object} */ export function IfState(data: object, prop: string, value: any, callBack: Function): any; /** * This will create an if state tag. * * @overload * @param {object} data * @param {string} prop * @param {*} value * @param {function} callBack * * @overload * @param {string} prop * @param {*} value * @param {function} callBack * * @returns {object} */ export function IfState(prop: string, value: any, callBack: Function): object; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnLoad(data: object, callBack: Function, notLoaded?: Function | object | null): any; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnLoad(callBack: Function, notLoaded?: Function | object | null): object; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnStateLoad(data: object, callBack: Function, notLoaded?: Function | object | null): any; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnStateLoad(callBack: Function, notLoaded?: Function | object | null): object; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnOpen(data: object, callBack: Function, notLoaded?: Function | object | null): any; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnOpen(callBack: Function, notLoaded?: Function | object | null): object; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnStateOpen(data: object, callBack: Function, notLoaded?: Function | object | null): any; /** * This will create an on load data tag. * * @overload * @param {object} data * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @overload * @param {function} callBack * @param {function|object|null} [notLoaded=null] * * @returns {object} */ export function OnStateOpen(callBack: Function, notLoaded?: Function | object | null): object;