如视 Five SDK
    Preparing search index...

    Function createStore

    • Type Parameters

      Parameters

      Returns {
          StoreProvider: typeof StoreProvider;
          useStore<K extends string | number | symbol>(
              names: K[],
          ): [values: Pick<T, K>, setValues: (values: Pick<T, K>) => void];
          useStoreAction<
              N extends string
              | number
              | symbol,
              F extends (...args: any[]) => any,
          >(
              actionName: N,
          ): F;
          useStoreSetter<K extends string | number | symbol>(
              names: K[],
          ): (values: Pick<T, K>) => void;
          watchStore<K extends string | number | symbol>(
              names: K[],
              callback: (values: Pick<T, K>, prevValues: Pick<T, K>) => void,
              deps?: DependencyList,
          ): void;
      }

      • StoreProvider: typeof StoreProvider

        Store Provider. 内部组件均可和 store 交互

      • useStore: function
        • 使用 Store

          Type Parameters

          • K extends string | number | symbol

          Parameters

          • names: K[]

            获取的 Store 字段

          Returns [values: Pick<T, K>, setValues: (values: Pick<T, K>) => void]

          [值, 修改值方法]

      • useStoreAction: function
        • Type Parameters

          • N extends string | number | symbol
          • F extends (...args: any[]) => any

          Parameters

          • actionName: N

          Returns F

      • useStoreSetter: function
        • 使用 Store (仅设置值)

          Type Parameters

          • K extends string | number | symbol

          Parameters

          • names: K[]

            获取的 Store 字段

          Returns (values: Pick<T, K>) => void

          修改值方法

      • watchStore: function
        • 监听 Store 变化

          Type Parameters

          • K extends string | number | symbol

          Parameters

          • names: K[]

            Store 字段

          • callback: (values: Pick<T, K>, prevValues: Pick<T, K>) => void

            监听变化的回调函数

          • Optionaldeps: DependencyList

            依赖对象

          Returns void