Package disposable

@typed/disposable

A handy interface for cleaning up after yourself.

Index

Namespaces

Disposable

Interfaces

LazyDisposable

Functions

Functions

Const dispose

dispose(disposable: Disposable): void

- Defined in packages/disposable/source/Disposable.ts:19
Cleanup a disposable

Parameters
- disposable: Disposable
  
  :: Disposable
Returns void

Const disposeAll

disposeAll(disposables: keyof Disposable[]): Disposable

- Defined in packages/disposable/source/disposeAll.ts:7
Clean up more than one disposable

Parameters
- disposables: keyof Disposable[]
  
  :: Disposable[]
Returns Disposable

onDisposed

onDisposed<A>(fn: (error?: A) => void, disposable: Disposable): Disposable

- Defined in packages/disposable/source/Disposable.ts:85
Type parameters
- A
Parameters
- fn: (error?: A) => void
  - - (error?: A): void
    - Parameters
      - Optional error: A
      Returns void
- disposable: Disposable
Returns Disposable

Const withIsDisposed

withIsDisposed(fn: (isDisposed: () => boolean) => void): Disposable

- Defined in packages/disposable/source/Disposable.ts:72
Parameters
- fn: (isDisposed: () => boolean) => void
  - - (isDisposed: () => boolean): void
    - Parameters
      - isDisposed: () => boolean
        
        (): boolean
        
        Returns boolean
      Returns void
Returns Disposable

Generated using TypeDoc