common-mpvue/types/index.d.ts

基于mpvue小程序的通用能力封装

import { StoreOptions, Store } from 'vuex/types/index';
import { BaseKV } from './general';
import { NavConfig, RequestConfig, AppConfig } from './config';
import { NavBarStyleOptions, RequestOptions } from './option';
import WX from './wx';
import APP from './app';
import WXP from './wxp';
import * as internal from './internal';

export as namespace WXAPPCommon;

export = WXAPPCommon;

declare namespace WXAPPCommon {
    /**
     * 全局的wx对象
     */
    export var wx: WX;

    /**
     * 获取当前小程序实例
     */
    export function getApp(): APP;

    /**
     * 获取当前页面栈
     */
    export function getCurrentPages(): internal.Page[];

    /**
     * 封装和扩展小程序app实例以及wx
     */
    export function wrap(App, config: AppConfig, props?: BaseKV);

    export class WrapPage<S> {
        constructor(Page, storeOptions?: StoreOptions<S>);
    }

    /**
     * 请求类
     */
    export class Request extends internal.Request {}

    /**
     * Promise化的wx API
     */
    export var wxp: WXP;

    /**
     * 可持久化至小程序storage的vuex store
     */
    export class PersistStore<S> extends internal.PersistStore<S> {}

    export class VuexStore<S> extends internal.VuexStore<S> {}

    /**
     * 实用工具函数
     */
    export interface Utils extends internal.Utils {}

    /**
     * EventEmitter
     */
    export class Emitter extends internal.Emitter {}

    /**
     * Navigator
     */
    export class Navigator extends internal.Navigator {}

    /**
     * Event Enum
     */
    export enum SystemEvent {
        // 登出
        LOGOUT = '_logout',
        // 登录中
        LOGINING = '_logining',
        // 登录结束
        LOGINEND = '_loginend',
        // 环境切换
        ENVCHANGE = '_env_change'
    }
}