Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Variables

Const TRACK_DISPOSABLES

TRACK_DISPOSABLES: false = false

Enables logging of potentially leaked disposables.

A disposable is considered leaked if it is not disposed or not registered as the child of another disposable. This tracking is very simple an only works for classes that either extend Disposable or use a DisposableStore. This means there are a lot of false positives.

Let disposableTracker

disposableTracker: IDisposableTracker | null = null

Functions

combinedDisposable

  • Parameters

    Returns IDisposable

dispose

  • dispose<T>(disposable: T): T
  • dispose<T>(disposable: T | undefined): T | undefined
  • dispose<T, A>(disposables: IterableIterator<T>): A
  • dispose<T>(disposables: Array<T>): Array<T>
  • dispose<T>(disposables: ReadonlyArray<T>): ReadonlyArray<T>
  • Type parameters

    Parameters

    • disposable: T

    Returns T

  • Type parameters

    Parameters

    • disposable: T | undefined

    Returns T | undefined

  • Type parameters

    • T: IDisposable

    • A: IterableIterator<T> = IterableIterator<T>

    Parameters

    • disposables: IterableIterator<T>

    Returns A

  • Type parameters

    Parameters

    • disposables: Array<T>

    Returns Array<T>

  • Type parameters

    Parameters

    • disposables: ReadonlyArray<T>

    Returns ReadonlyArray<T>

isDisposable

  • isDisposable<E>(thing: E): thing is E & IDisposable
  • Type parameters

    • E: object

    Parameters

    • thing: E

    Returns thing is E & IDisposable

markTracked

  • markTracked<T>(x: T): void
  • Type parameters

    Parameters

    • x: T

    Returns void

once

  • once<T>(this: unknown, fn: T): T
  • Type parameters

    • T: Function

    Parameters

    • this: unknown
    • fn: T

    Returns T

setDisposableTracker

  • Parameters

    Returns void

toDisposable

  • Parameters

    • fn: () => void
        • (): void
        • Returns void

    Returns IDisposable

trackDisposable

  • trackDisposable<T>(x: T): T
  • Type parameters

    Parameters

    • x: T

    Returns T

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property
  • Static property

Generated using TypeDoc