zeed
    Preparing search index...

    Function useDisposeWithUtils

    • Like useDispose but with shorthands for emitter and timers

      Parameters

      Returns (strictSync?: boolean) => void | Promise<any> & {
          add: (obj?: Disposer) => DisposerFunction | undefined;
          dispose: (strictSync?: boolean) => void | Promise<any>;
          disposed: number;
          disposeSync: () => void;
          exec: (strictSync?: boolean) => void | Promise<any>;
          remove: (disposable: Disposer) => void | Promise<void>;
          sync: () => void;
          track: (obj?: Disposer) => DisposerFunction | undefined;
          untrack: (disposable: Disposer) => void | Promise<void>;
          "[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?: Disposer) => DisposerFunction | undefined
      • dispose: (strictSync?: boolean) => void | Promise<any>
      • disposed: number

        Counter that incremends, each time dispose has been called

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

        use dispose

      • remove: (disposable: Disposer) => void | Promise<void>
      • sync: () => void
      • track: (obj?: Disposer) => DisposerFunction | undefined

        use add

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

        use remove

      • [asyncDispose]: function
      • [dispose]: function
      • getSize: function
      • isDisposed: function