@velis/dynamicforms
Version:
Data entry boilerplate components and a RESTful API consumer
23 lines • 1.52 kB
TypeScript
import { ComponentPublicInstance } from 'vue';
import Action from './action';
import FilteredActions from './filtered-actions';
import type { ActionsNS } from './namespace';
type ActionHandlerExtraData = ActionsNS.ActionHandlerExtraData;
/**
* Action is handled by a specific function on a component. First parent component which has this function
* defined executes this function with arguments actionData, payload. Payload is a computed variable, for payload
* value, value of first parent component's payload computed value is taken if payload computed var is defined.
* If this function returns false then current component tries to execute functionName(payload)
*
* Function name which executes action data is "calculated from actionData attributes."
*
* @param self: ComponentPublicInstance
* @param actions: Action
* @param extraData: object - e.g. { fieldName: 'field' }
*/
export declare function dispatchAction(self: ComponentPublicInstance, actions: Action | FilteredActions, extraData: ActionHandlerExtraData): Promise<void>;
declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {
dispatchAction(actions: Action | FilteredActions, extraData: ActionHandlerExtraData): Promise<void>;
}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;
//# sourceMappingURL=action-handler-mixin.d.ts.map