vuex-smart-module/lib/context.d.ts

Type safe Vuex module with powerful module features

import { Store, CommitOptions, DispatchOptions } from 'vuex';
import { Payload, Dispatcher, Committer } from './assets';
import { Module } from './module';
export interface Commit<M> {
    <K extends keyof M>(type: K, payload: Payload<M[K]>, options?: CommitOptions): void;
    <K extends keyof M>(payload: Payload<M[K]> & {
        type: K;
    }, options?: CommitOptions): void;
    <K extends {
        [K in keyof M]: M[K] extends () => any ? K : never;
    }[keyof M]>(type: K): void;
}
export interface Dispatch<A> {
    <K extends keyof A>(type: K, payload: Payload<A[K]>, options?: DispatchOptions): Promise<unknown>;
    <K extends keyof A>(payload: Payload<A[K]> & {
        type: K;
    }, options?: DispatchOptions): Promise<unknown>;
    <K extends {
        [K in keyof A]: A[K] extends () => any ? K : never;
    }[keyof A]>(type: K): Promise<unknown>;
}
declare type State<Mod extends Module<any, any, any, any, any>> = Mod extends Module<infer R, any, any, any, any> ? R : never;
declare type Getters<Mod extends Module<any, any, any, any, any>> = Mod extends Module<any, infer R, any, any, any> ? R : never;
declare type Mutations<Mod extends Module<any, any, any, any, any>> = Mod extends Module<any, any, infer R, any, any> ? R : never;
declare type Actions<Mod extends Module<any, any, any, any, any>> = Mod extends Module<any, any, any, infer R, any> ? R : never;
declare type ModulesContexts<Mod extends Module<any, any, any, any, any>> = Mod extends Module<any, any, any, any, infer R> ? {
    [K in keyof R]: Context<R[K]>;
} : never;
export interface ContextPosition {
    path: string[];
    namespace: string;
}
export declare function createLazyContextPosition(module: Module<any, any, any, any, any>): ContextPosition;
export declare function commit(store: Store<any>, namespace: string, type: any, payload: any, options?: any): void;
export declare function dispatch(store: Store<any>, namespace: string, type: any, payload: any, options?: any): Promise<unknown>;
export declare function getters(store: Store<any>, namespace: string): any;
export declare class Context<Mod extends Module<any, any, any, any, any>> {
    private pos;
    private store;
    private moduleOptions;
    private __mutations__?;
    private __actions__?;
    get mutations(): Committer<Mutations<Mod>>;
    get actions(): Dispatcher<Actions<Mod>>;
    commit: Commit<Mutations<Mod>>;
    dispatch: Dispatch<Actions<Mod>>;
    get state(): State<Mod>;
    get getters(): Getters<Mod>;
    get modules(): ModulesContexts<Mod>;
}
export {};