react-modal-promise/lib/types.d.ts

Promise wrapper for React components

/// <reference types="react" />
import { Hex } from './utils';
export declare type Scope = string;
export interface ScopeModel {
    [key: string]: ContainerRef;
}
export declare type InstanceId = Hex | string;
export declare type Resolver = <T>(id: InstanceId, value?: T) => T | void;
export declare type Rejector = <T>(id: InstanceId, reason?: T) => T | void;
export declare type InstanceComponent<T> = React.ComponentType<T>;
export interface InstanceOptions {
    scope?: Scope;
    instanceId?: InstanceId;
    enterTimeout?: number;
    exitTimeout?: number;
}
export interface InstanceProps<Resolve, Reject = Resolve> extends InstanceOptions {
    isOpen: boolean;
    instanceId: Hex;
    onReject: (rej?: Reject) => void;
    onResolve: (res?: Resolve) => void;
    /** @deprecated **/
    open: boolean;
    /** @deprecated **/
    close: (res?: Resolve) => void;
}
export interface Instance extends InstanceOptions {
    Component: InstanceComponent<any>;
    props: InstanceOptions;
    resolve: (value?: any) => void;
    reject: (reason?: any) => void;
}
export interface ContainerProps extends InstanceOptions {
    isAppendIntances?: boolean;
    onOpen?: (id?: InstanceId, instance?: Instance) => void;
    onResolve?: Resolver;
    onReject?: Rejector;
    onRemove?: (id?: InstanceId) => void;
}
export interface ContainerRef {
    create: InstanceCreator;
    resolve: Resolver;
    resolveAll: <T>(value?: T) => void;
    reject: Rejector;
    rejectAll: <T>(reason?: T) => void;
    getInstance: (id: InstanceId) => Instance | null;
    hasInstance: (id: InstanceId) => boolean;
}
export interface CreateInstance {
    <T extends InstanceProps<Resolve, Reject>, Resolve = any, Reject = Resolve>(Component: InstanceComponent<T>, options?: InstanceOptions): (props?: Omit<T, keyof InstanceProps<Resolve, Reject>> & Partial<InstanceProps<Resolve, Reject>>) => Promise<Resolve>;
}
export declare type InstanceCreator = <T, Resolve, Reject = Resolve>(Component: InstanceComponent<T>, options?: InstanceOptions, props?: Omit<T, keyof InstanceProps<Resolve, Reject>> & Partial<InstanceProps<Resolve, Reject>>) => Promise<Resolve>;