Function useAction

  • useAction<T>(options?): {
        act: (<K>(options) => Promise<void>);
        actMap: Map<Middleware<any>, Set<string | keyof T>>;
        acting: (<K>(...keys) => boolean);
        actings: (string | keyof T)[];
        evMap: Map<string | keyof T, Record<any, any>[]>;
        unuse: (<K>(keys, ...handles) => void);
        use: (<K>(keys, ...handles) => void);
        using: (<K>(options, ...handles) => void);
    }

  • useAction Hook 用于在 Vue 组件之间共享状态和实现组件通信

    Type Parameters

    • T extends Record<string, any>

    Parameters

    • options: {
          $key?: string | symbol;
          $mode?: "inject" | "provide" | "auto";
      } = {}

      配置项

      • Optional $key?: string | symbol

        key

      • Optional $mode?: "inject" | "provide" | "auto"

        模式

    Returns {
        act: (<K>(options) => Promise<void>);
        actMap: Map<Middleware<any>, Set<string | keyof T>>;
        acting: (<K>(...keys) => boolean);
        actings: (string | keyof T)[];
        evMap: Map<string | keyof T, Record<any, any>[]>;
        unuse: (<K>(keys, ...handles) => void);
        use: (<K>(keys, ...handles) => void);
        using: (<K>(options, ...handles) => void);
    }

    useAction 实例

    • act: (<K>(options) => Promise<void>)
        • <K>(options): Promise<void>

        • Type Parameters

          • K extends string = undefined

          Parameters

          • options: IsEqual<T[K], unknown> extends true
                ? keyof T | K | K[] | (keyof T)[] | {
                    $: keyof T | K | K[] | (keyof T)[];
                } & UnionToIntersection<T[K & keyof T]> & Record<any, any>
                : {
                    $: keyof T | K | K[] | (keyof T)[];
                } & UnionToIntersection<T[K & keyof T]> & Record<any, any>

          Returns Promise<void>

    • actMap: Map<Middleware<any>, Set<string | keyof T>>
    • acting: (<K>(...keys) => boolean)
        • <K>(...keys): boolean

        • Type Parameters

          • K extends string

          Parameters

          • Rest ...keys: (keyof T)[] | K[]

          Returns boolean

    • actings: (string | keyof T)[]
    • evMap: Map<string | keyof T, Record<any, any>[]>
    • unuse: (<K>(keys, ...handles) => void)
        • <K>(keys, ...handles): void

        • Type Parameters

          • K extends string

          Parameters

          • keys: keyof T | (keyof T)[] | K | K[]
          • Rest ...handles: Middleware<UnionToIntersection<T[K & keyof T]> & Record<any, any>>[]

          Returns void

    • use: (<K>(keys, ...handles) => void)
        • <K>(keys, ...handles): void

        • Type Parameters

          • K extends string

          Parameters

          • keys: keyof T | (keyof T)[] | K | K[]
          • Rest ...handles: Middleware<UnionToIntersection<T[K & keyof T]> & Record<any, any>>[]

          Returns void

    • using: (<K>(options, ...handles) => void)
        • <K>(options, ...handles): void

        • Type Parameters

          • K extends string = undefined

          Parameters

          • options: IsEqual<T[K], unknown> extends true
                ? keyof T | (keyof T)[] | K | K[] | {
                    $: keyof T | (keyof T)[] | K | K[];
                } & UnionToIntersection<T[K & keyof T]> & Record<any, any>
                : {
                    $: keyof T | (keyof T)[] | K | K[];
                } & UnionToIntersection<T[K & keyof T]> & Record<any, any>
          • Rest ...handles: Middleware<UnionToIntersection<T[K & keyof T]> & Record<any, any>>[]

          Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc