UNPKG

5.07 kBTypeScriptView Raw
1export interface Action {
2 type: string;
3}
4export declare interface TypedAction<T extends string> extends Action {
5 readonly type: T;
6}
7export declare type ActionType<A> = A extends ActionCreator<infer T, infer C> ? ReturnType<C> & {
8 type: T;
9} : never;
10export declare type TypeId<T> = () => T;
11export declare type InitialState<T> = Partial<T> | TypeId<Partial<T>> | void;
12/**
13 * A function that takes an `Action` and a `State`, and returns a `State`.
14 * See `createReducer`.
15 */
16export interface ActionReducer<T, V extends Action = Action> {
17 (state: T | undefined, action: V): T;
18}
19export declare type ActionReducerMap<T, V extends Action = Action> = {
20 [p in keyof T]: ActionReducer<T[p], V>;
21};
22export interface ActionReducerFactory<T, V extends Action = Action> {
23 (reducerMap: ActionReducerMap<T, V>, initialState?: InitialState<T>): ActionReducer<T, V>;
24}
25export declare type MetaReducer<T = any, V extends Action = Action> = (reducer: ActionReducer<T, V>) => ActionReducer<T, V>;
26export interface StoreFeature<T, V extends Action = Action> {
27 key: string;
28 reducers: ActionReducerMap<T, V> | ActionReducer<T, V>;
29 reducerFactory: ActionReducerFactory<T, V>;
30 initialState?: InitialState<T>;
31 metaReducers?: MetaReducer<T, V>[];
32}
33export declare type Selector<T, V> = (state: T) => V;
34/**
35 * @deprecated Selectors with props are deprecated, for more info see {@link https://github.com/ngrx/platform/issues/2980 Github Issue}
36 */
37export declare type SelectorWithProps<State, Props, Result> = (state: State, props: Props) => Result;
38export declare const arraysAreNotAllowedMsg = "action creator cannot return an array";
39declare type ArraysAreNotAllowed = typeof arraysAreNotAllowedMsg;
40export declare const typePropertyIsNotAllowedMsg = "action creator cannot return an object with a property named `type`";
41declare type TypePropertyIsNotAllowed = typeof typePropertyIsNotAllowedMsg;
42export declare const emptyObjectsAreNotAllowedMsg = "action creator cannot return an empty object";
43declare type EmptyObjectsAreNotAllowed = typeof emptyObjectsAreNotAllowedMsg;
44export declare const arraysAreNotAllowedInProps = "action creator props cannot be an array";
45declare type ArraysAreNotAllowedInProps = typeof arraysAreNotAllowedInProps;
46export declare const typePropertyIsNotAllowedInProps = "action creator props cannot have a property named `type`";
47declare type TypePropertyIsNotAllowedInProps = typeof typePropertyIsNotAllowedInProps;
48export declare const emptyObjectsAreNotAllowedInProps = "action creator props cannot be an empty object";
49declare type EmptyObjectsAreNotAllowedInProps = typeof emptyObjectsAreNotAllowedInProps;
50export declare const primitivesAreNotAllowedInProps = "action creator props cannot be a primitive value";
51declare type PrimitivesAreNotAllowedInProps = typeof primitivesAreNotAllowedInProps;
52export declare type FunctionIsNotAllowed<T, ErrorMessage extends string> = T extends Function ? ErrorMessage : T;
53/**
54 * A function that returns an object in the shape of the `Action` interface. Configured using `createAction`.
55 */
56export declare type Creator<P extends any[] = any[], R extends object = object> = FunctionWithParametersType<P, R>;
57export declare type Primitive = string | number | bigint | boolean | symbol | null | undefined;
58export declare type NotAllowedCheck<T extends object> = T extends any[] ? ArraysAreNotAllowed : T extends {
59 type: any;
60} ? TypePropertyIsNotAllowed : keyof T extends never ? EmptyObjectsAreNotAllowed : unknown;
61export declare type NotAllowedInPropsCheck<T> = T extends object ? T extends any[] ? ArraysAreNotAllowedInProps : T extends {
62 type: any;
63} ? TypePropertyIsNotAllowedInProps : keyof T extends never ? EmptyObjectsAreNotAllowedInProps : unknown : T extends Primitive ? PrimitivesAreNotAllowedInProps : never;
64/**
65 * See `Creator`.
66 */
67export declare type ActionCreator<T extends string = string, C extends Creator = Creator> = C & TypedAction<T>;
68export interface ActionCreatorProps<T> {
69 _as: 'props';
70 _p: T;
71}
72export declare type FunctionWithParametersType<P extends unknown[], R = void> = (...args: P) => R;
73export declare type ParametersType<T> = T extends (...args: infer U) => unknown ? U : never;
74export interface RuntimeChecks {
75 /**
76 * Verifies if the state is serializable
77 */
78 strictStateSerializability: boolean;
79 /**
80 * Verifies if the actions are serializable. Please note, you may not need to set it to `true` unless you are storing/replaying actions using external resources, for example `localStorage`.
81 */
82 strictActionSerializability: boolean;
83 /**
84 * Verifies that the state isn't mutated
85 */
86 strictStateImmutability: boolean;
87 /**
88 * Verifies that actions aren't mutated
89 */
90 strictActionImmutability: boolean;
91 /**
92 * Verifies that actions are dispatched within NgZone
93 */
94 strictActionWithinNgZone: boolean;
95 /**
96 * Verifies that action types are not registered more than once
97 */
98 strictActionTypeUniqueness?: boolean;
99}
100export {};