piral-core/lib/actions/app.d.ts

The core library for creating a Piral instance.

import { ComponentType } from 'react';
import { RouteComponentProps } from 'react-router';
import { ComponentsState, ErrorComponentsState, GlobalStateContext, Pilet, PiletEntry } from '../types';
export declare function initialize(ctx: GlobalStateContext, loading: boolean, error: Error | undefined, modules: Array<Pilet>): void;
export declare function addPilet(ctx: GlobalStateContext, meta: PiletEntry): Promise<void>;
export declare function removePilet(ctx: GlobalStateContext, name: string): Promise<void>;
export declare function injectPilet(ctx: GlobalStateContext, pilet: Pilet): Pilet;
export declare function setComponent<TKey extends keyof ComponentsState>(ctx: GlobalStateContext, name: TKey, component: ComponentsState[TKey]): void;
export declare function setErrorComponent<TKey extends keyof ErrorComponentsState>(ctx: GlobalStateContext, type: TKey, component: ErrorComponentsState[TKey]): void;
export declare function setRoute<T extends {
    [K in keyof T]?: string;
} = {}>(ctx: GlobalStateContext, path: string, component: ComponentType<RouteComponentProps<T>>): void;
export declare function includeProvider(ctx: GlobalStateContext, provider: JSX.Element): void;