Function useDisposeWithUtils

Returns (strictSync?: boolean) => void | Promise<any> & {
    add: (obj?: DisposableEntry) => DisposerFunction | undefined;
    dispose: (strictSync?: boolean) => void | Promise<any>;
    disposeSync: () => void;
    exec: (strictSync?: boolean) => void | Promise<any>;
    remove: (disposable: DisposableEntry) => void | Promise<void>;
    sync: () => void;
    track: (obj?: DisposableEntry) => DisposerFunction | undefined;
    untrack: (disposable: DisposableEntry) => void | Promise<void>;
    get disposed(): number;
    "[asyncDispose]"(): Promise<any>;
    "[dispose]"(): void | Promise<any>;
    getSize(): number;
    isDisposed(): boolean;
} & {
    interval: (fn: TimerExecFunction, interval?: number) => DisposerFunction;
    intervalPause: (
        fn: TimerExecFunction,
        interval?: number,
    ) => DisposerFunction;
    on: (
        emitter: any,
        eventName: string,
        fn: (ev?: any) => void,
        ...args: any[],
    ) => DisposerFunction;
    once: (
        emitter: any,
        eventName: string,
        fn: (ev?: any) => void,
        ...args: any[],
    ) => DisposerFunction;
    timeout: (fn: TimerExecFunction, timeout?: number) => DisposerFunction;
}

• • (strictSync?: boolean): void | Promise<any>

  • Dispose all tracked entries

    Parameters

    • strictSync: boolean = false

    Returns void | Promise<any>

• add: (obj?: DisposableEntry) => DisposerFunction | undefined

• dispose: (strictSync?: boolean) => void | Promise<any>

• disposeSync: () => void

• exec: (strictSync?: boolean) => void | Promise<any>

  Deprecated

  use dispose

• remove: (disposable: DisposableEntry) => void | Promise<void>

• sync: () => void

• track: (obj?: DisposableEntry) => DisposerFunction | undefined

  Deprecated

  use add

• untrack: (disposable: DisposableEntry) => void | Promise<void>

  Deprecated

  use remove

• get disposed(): number

  Counter that increments each time dispose has been called

• [asyncDispose]: function

  • "[asyncDispose]"(): Promise<any>

    Returns Promise<any>

• [dispose]: function

  • "[dispose]"(): void | Promise<any>

    Returns void | Promise<any>

• getSize: function

  • getSize(): number

    Returns number

• isDisposed: function

  • isDisposed(): boolean

    Returns boolean

• interval: (fn: TimerExecFunction, interval?: number) => DisposerFunction

• intervalPause: (fn: TimerExecFunction, interval?: number) => DisposerFunction

• on: (
      emitter: any,
      eventName: string,
      fn: (ev?: any) => void,
      ...args: any[],
  ) => DisposerFunction

• once: (
      emitter: any,
      eventName: string,
      fn: (ev?: any) => void,
      ...args: any[],
  ) => DisposerFunction

• timeout: (fn: TimerExecFunction, timeout?: number) => DisposerFunction