pijul nest
guest › [sign in] [explore]

Add documentation to utility functions

[?]
Dec 23, 2020, 10:41 PM
25F2OOEBMMVFXZF4E4DTBTSOQWEGYT2YXCTYRY2HXGHT6MKPDX2AC

Dependencies

  • [2] 6WGBCLHN Add event and disposable utility modules

Change contents

  • edit in src/eventUtils.ts at line 12
    [2.555]
    [2.555]
    /**
    * Wrap an event in an event that only fire when a certain condition is true
    * @param event The event that will be wrapped
    * @param filter A predicate function whhich will be run on the event result to determine if the event should be propagated.
    */
  • edit in src/eventUtils.ts at line 21
    [2.800]
    [2.800]
    /**
    * Returns an event that fires when any of the given events fire
    * @param events An array of events that will trigger the returned event
    */
  • edit in src/eventUtils.ts at line 48
    [2.1438]
    [2.1438]
    /**
    * Wraps an event in an event that prevents it from firing too frequently
    * @param event The event that will be wrapped
    * @param delay The minimum amount of time between event fires
    */
  • edit in src/eventUtils.ts at line 63
    [2.1782]
    [2.1782]
    /**
    * Convert an event into an awaitable promise
    * @param event The event that can be awaited
    */
  • edit in src/disposableUtils.ts at line 1
    [2.1947]
    [2.1948]
    /**
    * An interface which represents an object which needs
    * to be disposed when it is no longer in use.
    */
  • edit in src/disposableUtils.ts at line 9
    [2.2004]
    [2.2004]
    /**
    * Dispose all of the items in an array of disposables
    * @param disposables The array of disposable objects
    */
  • edit in src/disposableUtils.ts at line 18
    [2.2134]
    [2.2134]
    /**
    * Convert a dispose function into an IDisposable object
    * @param dispose The dipose function
    */
  • edit in src/disposableUtils.ts at line 26
    [2.2225]
    [2.2225]
    /**
    * Combine an array of disposables into a single disposable object
    * @param disposables The array of disposable objects
    */
  • edit in src/disposableUtils.ts at line 34
    [2.2358]
    [2.2358]
    /**
    * A Disposable object which does nothing
    */