CoroutineInstance

Hierarchy

• PromiseLike<void>
  • CoroutineInstance

Index

Properties

• [iterator]
• cancel
• done
• generator
• start
• then

Methods

• isComplete
• isRunning

Properties

[iterator]

[iterator]: () => Generator<number | Promise<any> | CoroutineInstance | undefined, void, number>

Type declaration

• • (): Generator<number | Promise<any> | CoroutineInstance | undefined, void, number>

  • Returns Generator<number | Promise<any> | CoroutineInstance | undefined, void, number>

cancel

cancel: () => void

Type declaration

• • (): void

  • Returns void

done

done: Promise<void>

generator

generator: Generator<number | Promise<any> | CoroutineInstance | undefined, void, number>

start

start: () => CoroutineInstance

Type declaration

• • (): CoroutineInstance

  • Returns CoroutineInstance

then

then: <TResult1, TResult2>(onfulfilled?: (value: void) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null) => PromiseLike<TResult1 | TResult2>

Overrides PromiseLike.then

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

---

Type declaration

• • <TResult1, TResult2>(onfulfilled?: (value: void) => TResult1 | PromiseLike<TResult1> | null, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2> | null): PromiseLike<TResult1 | TResult2>
  • ---

    Type parameters

    • TResult1 = void
    • TResult2 = never

    Parameters

    • optionalonfulfilled: (value: void) => TResult1 | PromiseLike<TResult1> | null

      The callback to execute when the Promise is resolved.

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

      The callback to execute when the Promise is rejected.

    Returns PromiseLike<TResult1 | TResult2>

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

Methods

isComplete

• isComplete(): boolean

• Returns boolean

isRunning

• isRunning(): boolean

• Returns boolean