Interface IHandle

apps/web/src/Modal.tsx:80–97

 * @typeParam C - The type of the React component which forms the body of the dialog.
 */
export interface IHandle<C extends ComponentType> {
    /**
     * A promise which will resolve when the dialog closes.
     *
     * If the dialog body component calls the `onFinished` property, or the caller calls {@link close},
     * the promise resolves with an array holding the arguments to that call.
     *
     * If the dialog is closed by clicking in the background, the promise resolves with an empty array.
     */
    finished: Promise<OnFinishedParams<C> | []>;

    /**
     * A function which, if called, will close the dialog.
     *
     * @param args - Arguments to return to {@link finished}.
     */
    close(this: void, ...args: OnFinishedParams<C>): void;
}

interface IOptions<C extends ComponentType> {
    onBeforeClose?: IModal<C>["onBeforeClose"];