@laserware/stasis
    Preparing search index...

    Interface Task<T>

    The Task interface specifies the result of running a Saga using fork, middleware.run or runSaga.

    interface Task<T = any> {
        cancel(): void;
        error(): any;
        isCancelled(): boolean;
        isRunning(): boolean;
        result<R = T>(): undefined | R;
        toPromise<R = T>(): Promise<R>;
    }

    Type Parameters

    • T = any
    Index

    Methods

    cancel error isCancelled isRunning result toPromise

    Methods

    • Cancels the task (If it is still running)

      Returns void

    • Returns task thrown error. undefined if task is still running

      Returns any

    • Returns true if the task has been cancelled

      Returns boolean

    • Returns true if the task hasn't yet returned or thrown an error

      Returns boolean

    • Returns task return value. undefined if task is still running

      Type Parameters

      • R = T

      Returns undefined | R

    • Returns a Promise which is either:

      • resolved with task's return value
      • rejected with task's thrown error

      Type Parameters

      • R = T

      Returns Promise<R>

    Settings

    Member Visibility

    On This Page

    Methods