@nlabs/arkhamjs/lib/Flux/Flux.types.d.ts

Javascript Flux Library

/**
 * Copyright (c) 2018-Present, Nitrogen Labs, Inc.
 * Copyrights licensed under the MIT License. See the accompanying LICENSE file for terms.
 */
export interface FluxOptions {
    readonly basename?: string;
    readonly context?: object;
    readonly debug?: boolean;
    readonly getUserConfirmation?: () => void;
    readonly hashType?: 'slash' | 'noslash' | 'hashbang';
    readonly history?: object;
    readonly initialEntries?: any[];
    readonly initialIndex?: number;
    readonly keyLength?: number;
    readonly location?: string | object;
    readonly middleware?: FluxMiddlewareType[];
    readonly name?: string;
    readonly routerType?: string;
    readonly scrollToTop?: boolean;
    readonly state?: any;
    readonly storage?: FluxStorageType;
    readonly storageWait?: number;
    readonly stores?: any[];
    readonly title?: string;
}
export interface FluxAction {
    readonly [key: string]: any;
    readonly type: string;
}
export interface FluxStorageType {
    readonly getStorageData?: (key: string) => Promise<any>;
    readonly setStorageData?: (key: string, value: any) => Promise<boolean>;
}
export interface FluxStore {
    readonly action: (type: string, data: any, state: any) => any;
    readonly name: string;
    readonly initialState: any;
}
export type FluxPluginMethodType = (action: FluxAction, store: object, appData?: object) => Promise<FluxAction>;
export interface FluxMiddlewareType {
    readonly name: string;
    readonly preDispatch?: FluxPluginMethodType;
    readonly postDispatch?: FluxPluginMethodType;
}
export interface FluxPluginType {
    readonly name: string;
    readonly method: FluxPluginMethodType;
}
export interface ErrorConstructor {
    captureStackTrace(thisArg: any, func: any): void;
}