@singularsystems/neo-core 1.0.0-alpha.3 → 1.0.0-beta.0

package/dist/Components/TaskRunner/TaskRunner.d.ts

@@ -1,114 +1,114 @@
-import { variant } from '..';
-import { AxiosPromise } from 'axios';
-import { IErrorHandler, ErrorDisplayType, IErrorDisplay } from '../ErrorHandler';
-import { ProgressState } from './ProgressState';
-declare type PromiseDictionary = {
-    [index: string]: Promise<any>;
-};
-declare type TransformPromises<T extends PromiseDictionary> = {
-    [P in keyof T]: T[P] extends Promise<infer I> ? I : never;
-};
-export declare class TaskRunnerOptions<T = any> {
-    private taskRunner;
-    constructor(taskRunner: TaskRunner);
-    /** Specifies how the task runner must handle errors that are raised by your code. */
-    errorHandling: ErrorDisplayType;
-    /**
-     * Callback to run when an error occurs.
-     *
-     * Setting the `cancelDisplay` property will prevent the error being displayed by the task runner.
-     */
-    onError?: (errorInfo: IErrorDisplay) => void;
-    /** Loading text to show in the loading bar */
-    loadingText: string;
-    variant: variant;
-    /** Progress % to start on. */
-    initialProgress: number;
-    /** Time in seconds for the progress to reach half way. */
-    halfLife: number;
-    /** False if the progress will be progressed manually. */
-    autoProgress: boolean;
-    /**
-     * If set, this value will be returned in a resolved promise if an error occurs.
-     *
-     * The error will still be displayed according to the `errorHandling` property.
-     */
-    defaultReturnValue: T;
-    get progressState(): ProgressState;
-}
-export declare class WaitForTaskRunnerOptions<T = any> extends TaskRunnerOptions<T> {
-    /**
-     * Set to true if you want to allow post requests when using `waitFor`.
-     *
-     * Usually posts will raise an error warning you use rather use `TaskRunner.run()`. Use this if the post method has no side effects.
-     */
-    allowPost: boolean;
-}
-export interface ITaskRunner {
-    isBusy: boolean;
-    options: TaskRunnerOptions;
-    progressState: ProgressState;
-    /**
-     * Runs a task, setting the isBusy property to true while busy.
-     * @param task Callback where work is performed. Options are passed into the callback.
-     */
-    run<T>(task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
-    /**
-     * Runs a task, setting the isBusy property to true while busy.
-     * @param loadingText Loading text to show in the loader component.
-     * @param task Callback where work is performed. Options are passed into the callback.
-     */
-    run<T>(loadingText: string, task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<void>;
-    /**
-     * Sets the isBusy property to true while the supplied promise is executing.
-     * @param task A promise which is busy executing.
-     * @param options Static options.
-     */
-    waitFor<T>(task: Promise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
-    /**
-     * Sets the isBusy property to true while the supplied axios promise is executing. The data in the axios response is returned.
-     * @param task Axios promise which is busy executing.
-     */
-    waitForData<T>(task: AxiosPromise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
-    /**
-     * Accepts a dictionary of promises, and waits for all of them to resolve.
-     *
-     * A dictionary with the same keys is returned with the results of each promise.
-     */
-    waitForAll<T extends PromiseDictionary>(promises: T, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<TransformPromises<T>>;
-}
-export default class TaskRunner implements ITaskRunner {
-    private errorHandler;
-    isBusy: boolean;
-    options: TaskRunnerOptions<any>;
-    progressState: ProgressState;
-    private runningTasks;
-    constructor(errorHandler: IErrorHandler);
-    /**
-     * Runs a task, setting the isBusy property to true while busy.
-     * @param task Callback where work is performed. Options are passed into the callback.
-     */
-    run<T>(task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
-    /**
-     * Runs a task, setting the isBusy property to true while busy.
-     * @param loadingText Loading text to show in the loader component.
-     * @param task Callback where work is performed. Options are passed into the callback.
-     */
-    run<T>(loadingText: string, task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
-    /**
-     * Sets the isBusy property to true while the supplied promise is executing.
-     * @param task A promise which is busy executing.
-     * @param options Static options.
-     */
-    waitFor<T>(task: Promise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
-    /**
-     * Accepts a dictionary of promises, and waits for all of them to resolve.
-     * A dictionary with the same keys is returned with the results of each promise.
-     */
-    waitForAll<T extends PromiseDictionary>(promises: T, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<TransformPromises<T>>;
-    waitForData<T>(task: AxiosPromise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
-    private runTask;
-    /** Waits the specified number of milliseconds. */
-    static delay(ms: number): Promise<unknown>;
-}
-export {};
+import { variant } from '..';
+import { AxiosPromise } from 'axios';
+import { IErrorHandler, ErrorDisplayType, IErrorDisplay } from '../ErrorHandler';
+import { ProgressState } from './ProgressState';
+type PromiseDictionary = {
+    [index: string]: Promise<any>;
+};
+type TransformPromises<T extends PromiseDictionary> = {
+    [P in keyof T]: T[P] extends Promise<infer I> ? I : never;
+};
+export declare class TaskRunnerOptions<T = any> {
+    private taskRunner;
+    constructor(taskRunner: TaskRunner);
+    /** Specifies how the task runner must handle errors that are raised by your code. */
+    errorHandling: ErrorDisplayType;
+    /**
+     * Callback to run when an error occurs.
+     *
+     * Setting the `cancelDisplay` property will prevent the error being displayed by the task runner.
+     */
+    onError?: (errorInfo: IErrorDisplay) => void;
+    /** Loading text to show in the loading bar */
+    loadingText: string;
+    variant: variant;
+    /** Progress % to start on. */
+    initialProgress: number;
+    /** Time in seconds for the progress to reach half way. */
+    halfLife: number;
+    /** False if the progress will be progressed manually. */
+    autoProgress: boolean;
+    /**
+     * If set, this value will be returned in a resolved promise if an error occurs.
+     *
+     * The error will still be displayed according to the `errorHandling` property.
+     */
+    defaultReturnValue: T;
+    get progressState(): ProgressState;
+}
+export declare class WaitForTaskRunnerOptions<T = any> extends TaskRunnerOptions<T> {
+    /**
+     * Set to true if you want to allow post requests when using `waitFor`.
+     *
+     * Usually posts will raise an error warning you use rather use `TaskRunner.run()`. Use this if the post method has no side effects.
+     */
+    allowPost: boolean;
+}
+export interface ITaskRunner {
+    isBusy: boolean;
+    options: TaskRunnerOptions;
+    progressState: ProgressState;
+    /**
+     * Runs a task, setting the isBusy property to true while busy.
+     * @param task Callback where work is performed. Options are passed into the callback.
+     */
+    run<T>(task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
+    /**
+     * Runs a task, setting the isBusy property to true while busy.
+     * @param loadingText Loading text to show in the loader component.
+     * @param task Callback where work is performed. Options are passed into the callback.
+     */
+    run<T>(loadingText: string, task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<void>;
+    /**
+     * Sets the isBusy property to true while the supplied promise is executing.
+     * @param task A promise which is busy executing.
+     * @param options Static options.
+     */
+    waitFor<T>(task: Promise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
+    /**
+     * Sets the isBusy property to true while the supplied axios promise is executing. The data in the axios response is returned.
+     * @param task Axios promise which is busy executing.
+     */
+    waitForData<T>(task: AxiosPromise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
+    /**
+     * Accepts a dictionary of promises, and waits for all of them to resolve.
+     *
+     * A dictionary with the same keys is returned with the results of each promise.
+     */
+    waitForAll<T extends PromiseDictionary>(promises: T, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<TransformPromises<T>>;
+}
+export default class TaskRunner implements ITaskRunner {
+    private errorHandler;
+    isBusy: boolean;
+    options: TaskRunnerOptions<any>;
+    progressState: ProgressState;
+    private runningTasks;
+    constructor(errorHandler: IErrorHandler);
+    /**
+     * Runs a task, setting the isBusy property to true while busy.
+     * @param task Callback where work is performed. Options are passed into the callback.
+     */
+    run<T>(task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
+    /**
+     * Runs a task, setting the isBusy property to true while busy.
+     * @param loadingText Loading text to show in the loader component.
+     * @param task Callback where work is performed. Options are passed into the callback.
+     */
+    run<T>(loadingText: string, task: (options: TaskRunnerOptions<T>) => Promise<T>): Promise<T>;
+    /**
+     * Sets the isBusy property to true while the supplied promise is executing.
+     * @param task A promise which is busy executing.
+     * @param options Static options.
+     */
+    waitFor<T>(task: Promise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
+    /**
+     * Accepts a dictionary of promises, and waits for all of them to resolve.
+     * A dictionary with the same keys is returned with the results of each promise.
+     */
+    waitForAll<T extends PromiseDictionary>(promises: T, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<TransformPromises<T>>;
+    waitForData<T>(task: AxiosPromise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
+    private runTask;
+    /** Waits the specified number of milliseconds. */
+    static delay(ms: number): Promise<unknown>;
+}
+export {};