Class Disposable

Index

Constructors

Methods

close getCancelationError getScope isCanceled onCancel run

Constructors

constructor

new Disposable(signal: AbortSignal): Disposable
Parameters
- signal: AbortSignal
Returns Disposable
- Defined in packages/umi-tasks/src/Disposable.ts:20

Methods

close

close(): void
Returns void
- Defined in packages/umi-tasks/src/Disposable.ts:71

getCancelationError

getCancelationError(): unknown
Returns unknown
- Defined in packages/umi-tasks/src/Disposable.ts:61

getScope

getScope(): DisposableScope
Returns DisposableScope
- Defined in packages/umi-tasks/src/Disposable.ts:44

isCanceled

isCanceled(): boolean
Returns boolean
- Defined in packages/umi-tasks/src/Disposable.ts:57

onCancel

onCancel(callback: (reason: unknown) => unknown): Disposable
Parameters
- callback: (reason: unknown) => unknown
Returns Disposable
- Defined in packages/umi-tasks/src/Disposable.ts:65

run

run<T>(
callback: (scope: DisposableScope) => T,
thenCloseDisposable?: boolean,
): Promise<T>
Type Parameters
- T
Parameters
- callback: (scope: DisposableScope) => T
- thenCloseDisposable: boolean = true
Returns Promise<T>
- Defined in packages/umi-tasks/src/Disposable.ts:31