vue-loadable/types/mapLoadableMethods.d.ts

Improves your loading state flow by providing methods and helpers to manage it.

import { Method, LoadableMethod } from './loadable';
/**
 * Type of an object whose keys are `string` and the values are methods.
 */
export declare type Methods = Record<string, Method>;
/**
 * A Higher-order type to transform methods into loadable methods. It keeps keys
 * as-is, but values have access to `this` (Vue instance) and returns a Promise.
 */
export declare type LoadableMethods<T extends Methods> = {
    [K in keyof T]: LoadableMethod<T[K]>;
};
/**
 * Maps an object, whose keys are `string` and the values are methods, to
 * loadable methods that triggers loading states. It uses property's keys as
 * loading state names.
 * @example
 * Vue.component('SignInForm', {
 *   ...,
 *   methods: {
 *     onClick() {
 *       if (this.$isLoading('signIn') || this.$isLoading('signUp'))
 *         return;
 *       // ...
 *     },
 *     ...mapLoadableMethods(
 *       mapActions('authentication', [
 *         'signIn',
 *         'signUp'
 *       ])
 *     )
 *   }
 * });
 */
declare const mapLoadableMethods: <T extends Record<string, Method>>(methods: T) => LoadableMethods<T>;
export default mapLoadableMethods;