Class Disposable

Hierarchy

Disposable

Index

Properties

eventEmitter signal cancelationError abortListener

Constructors

Methods

run getScope isCanceled getCancelationError onCancel close

Properties

`Protected` eventEmitter

eventEmitter: EventEmitter<string | symbol, any>

`Protected` signal

signal: AbortSignal

`Protected` cancelationError

cancelationError: unknown = null

`Protected` abortListener

abortListener: ((error: unknown) => void)

Type declaration

- (error: unknown): void
- Parameters
  - error: unknown
  Returns void

Constructors

constructor

new Disposable(signal: AbortSignal): Disposable
Parameters
- signal: AbortSignal
Returns Disposable
- Defined in packages/js/src/utils/Disposable.ts:17

Methods

run

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

getScope

getScope(): DisposableScope
Returns DisposableScope
- Defined in packages/js/src/utils/Disposable.ts:41

isCanceled

isCanceled(): boolean
Returns boolean
- Defined in packages/js/src/utils/Disposable.ts:54

getCancelationError

getCancelationError(): unknown
Returns unknown
- Defined in packages/js/src/utils/Disposable.ts:58

onCancel

onCancel(callback: ((reason: unknown) => unknown)): Disposable
Parameters
- callback: ((reason: unknown) => unknown)
  - - (reason: unknown): unknown
    - Parameters
      
      reason: unknown
      
      Returns unknown
Returns Disposable
- Defined in packages/js/src/utils/Disposable.ts:62

close

close(): void
Returns void
- Defined in packages/js/src/utils/Disposable.ts:68

Generated using TypeDoc