k-ramel/dist/index.d.ts

State manager for you components apps, the safe and easy way.

declare module "k-ramel" {
  import {
    TypeDefinition,
    TypeDefinitionFunction,
    ReducerType
  } from "k-redux-factory";
  import { compose, applyMiddleware, Dispatch, enhanceMiddleware } from "redux";
  export { Types } from "k-redux-factory";
  export type StoreOptions = {
    hideRedux?: boolean;
    enhancer?: any;
    init?: any;
    listeners?: any;
    devtools?: any;
    trace?: boolean;
    traceLimit?: number;
    name?: string;
    drivers?: any;
  };

  export interface StoreDefinition {
    [key: string]: StoreDefinition | TypeDefinition;
  }

  export interface StoreDefinitionBase {
    [key: string]: StoreDefinitionBase | ReducerType;
  }

  export type API = {
    [key: string]: any;
  };
  export type Driver<Store extends StoreDefinitionBase> = {
    getDriver: (store: Store) => API;
    getReducer?: () => {
      path: string;
      reducers: StoreDefinitionBase;
    };
    init?: (store: Store) => void;
    getEnhancer?: () =>
      | ReturnValue<typeof compose>
      | ReturnValue<typeof enhanceMiddleware>;
  };

  export function createStore<Store extends StoreDefinitionBase>(
    definition: StoreDefinition,
    options?: StoreOptions
  ): Store;
  export const types: TypeDefinitionFunction;

  export interface StoreBase extends StoreDefinitionBase {
    dispatch: Dispatch;
    listeners: any;
  }

  export interface BaseAction {
    type: string;
  }

  export type ReactionType<
    A extends API = {},
    S extends StoreDefinitionBase = {},
    D = {}
  > = (action: A & BaseAction, store: S & StoreBase, drivers: D) => any;

  export const when: (
    ...matchers: (string | RegExp)[]
  ) => <A extends API, S extends StoreDefinitionBase, D>(
    callback: ReactionType<A, S, D>
  ) => ReactionType<A, S, D>;
}