vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Interface TaskPromise<TResult, TProgress>

    interface TaskPromise<TResult, TProgress = unknown> {
        "[toStringTag]": string;
        hasError: boolean;
        isFinished: boolean;
        isRunning: boolean;
        cancel(): Promise<TaskPromise<TResult, TProgress>>;
        catch<TResult = never>(
            onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>),
        ): Promise<TResult | TResult>;
        finally(onfinally?: null | (() => void)): Promise<TResult>;
        on<K extends keyof TaskEvents<TResult, TProgress>>(
            event: K,
            listener: (...args: TaskEvents<TResult, TProgress>[K]) => void,
        ): this;
        then<TResult1 = TResult, TResult2 = never>(
            onfulfilled?:
                | null
                | ((value: TResult) => TResult1 | PromiseLike<TResult1>),
            onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>),
        ): Promise<TResult1 | TResult2>;
    }

    Type Parameters

    • TResult
    • TProgress = unknown

    Hierarchy

    Implemented by

    Index

    Properties

    "[toStringTag]": string
    hasError: boolean
    isFinished: boolean
    isRunning: boolean

    Methods

    • Attaches a callback for only the rejection of the Promise.

      Type Parameters

      • TResult = never

      Parameters

      • Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

        The callback to execute when the Promise is rejected.

      Returns Promise<TResult | TResult>

      A Promise for the completion of the callback.

    • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

      Parameters

      • Optionalonfinally: null | (() => void)

        The callback to execute when the Promise is settled (fulfilled or rejected).

      Returns Promise<TResult>

      A Promise for the completion of the callback.

    • Attaches callbacks for the resolution and/or rejection of the Promise.

      Type Parameters

      Parameters

      • Optionalonfulfilled: null | ((value: TResult) => TResult1 | PromiseLike<TResult1>)

        The callback to execute when the Promise is resolved.

      • Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

        The callback to execute when the Promise is rejected.

      Returns Promise<TResult1 | TResult2>

      A Promise for the completion of which ever callback is executed.