-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #27 from JonahKr/master
Added Debounce and FormatNumber Functions
- Loading branch information
Showing
4 changed files
with
487 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| <!doctype html> | ||
| <html class="default no-js"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <title>"debounce" | custom-card-helpers</title> | ||
| <meta name="description" content="Documentation for custom-card-helpers"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <link rel="stylesheet" href="../assets/css/main.css"> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| <div class="tsd-page-toolbar"> | ||
| <div class="container"> | ||
| <div class="table-wrap"> | ||
| <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> | ||
| <div class="field"> | ||
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | ||
| <input id="tsd-search-field" type="text" /> | ||
| </div> | ||
| <ul class="results"> | ||
| <li class="state loading">Preparing search index...</li> | ||
| <li class="state failure">The search index is not available</li> | ||
| </ul> | ||
| <a href="../index.html" class="title">custom-card-helpers</a> | ||
| </div> | ||
| <div class="table-cell" id="tsd-widgets"> | ||
| <div id="tsd-filter"> | ||
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | ||
| <div class="tsd-filter-group"> | ||
| <div class="tsd-select" id="tsd-filter-visibility"> | ||
| <span class="tsd-select-label">All</span> | ||
| <ul class="tsd-select-list"> | ||
| <li data-value="public">Public</li> | ||
| <li data-value="protected">Public/Protected</li> | ||
| <li data-value="private" class="selected">All</li> | ||
| </ul> | ||
| </div> | ||
| <input type="checkbox" id="tsd-filter-inherited" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | ||
| <input type="checkbox" id="tsd-filter-externals" checked /> | ||
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> | ||
| <input type="checkbox" id="tsd-filter-only-exported" /> | ||
| <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> | ||
| </div> | ||
| </div> | ||
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="tsd-page-title"> | ||
| <div class="container"> | ||
| <ul class="tsd-breadcrumb"> | ||
| <li> | ||
| <a href="../globals.html">Globals</a> | ||
| </li> | ||
| <li> | ||
| <a href="_debounce_.html">"debounce"</a> | ||
| </li> | ||
| </ul> | ||
| <h1>Module "debounce"</h1> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container container-main"> | ||
| <div class="row"> | ||
| <div class="col-8 col-content"> | ||
| <section class="tsd-panel-group tsd-index-group"> | ||
| <h2>Index</h2> | ||
| <section class="tsd-panel tsd-index-panel"> | ||
| <div class="tsd-index-content"> | ||
| <section class="tsd-index-section "> | ||
| <h3>Functions</h3> | ||
| <ul class="tsd-index-list"> | ||
| <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_debounce_.html#debounce" class="tsd-kind-icon">debounce</a></li> | ||
| </ul> | ||
| </section> | ||
| </div> | ||
| </section> | ||
| </section> | ||
| <section class="tsd-panel-group tsd-member-group "> | ||
| <h2>Functions</h2> | ||
| <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"> | ||
| <a name="debounce" class="tsd-anchor"></a> | ||
| <h3><span class="tsd-flag ts-flagConst">Const</span> debounce</h3> | ||
| <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"> | ||
| <li class="tsd-signature tsd-kind-icon">debounce<T><span class="tsd-signature-symbol">(</span>func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, wait<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, immediate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li> | ||
| </ul> | ||
| <ul class="tsd-descriptions"> | ||
| <li class="tsd-description"> | ||
| <aside class="tsd-sources"> | ||
| <ul> | ||
| <li>Defined in <a href="https://github.com/custom-cards/custom-card-helpers/blob/be02578/src/debounce.ts#L10">src/debounce.ts:10</a></li> | ||
| </ul> | ||
| </aside> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>Returns a function, that, as long as it continues to be invoked, will not be triggered. It will be called after it stops being called for <code>wait</code> ms. | ||
| This can be usefull for ResizeObservers for example.</p> | ||
| </div> | ||
| </div> | ||
| <h4 class="tsd-type-parameters-title">Type parameters</h4> | ||
| <ul class="tsd-type-parameters"> | ||
| <li> | ||
| <h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">unknown</span></h4> | ||
| </li> | ||
| </ul> | ||
| <h4 class="tsd-parameters-title">Parameters</h4> | ||
| <ul class="tsd-parameters"> | ||
| <li> | ||
| <h5>func: <span class="tsd-signature-type">T</span></h5> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>The function you want to debounce</p> | ||
| </div> | ||
| </div> | ||
| </li> | ||
| <li> | ||
| <h5>wait: <span class="tsd-signature-type">number</span></h5> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>Period to wait in ms</p> | ||
| </div> | ||
| </div> | ||
| </li> | ||
| <li> | ||
| <h5><span class="tsd-flag ts-flagDefault value">Default value</span> immediate: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5> | ||
| <div class="tsd-comment tsd-typography"> | ||
| <div class="lead"> | ||
| <p>Triggering on the leading edge instead of the trailing</p> | ||
| </div> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4> | ||
| <p>Debounced Function</p> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| </section> | ||
| </div> | ||
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | ||
| <nav class="tsd-navigation primary"> | ||
| <ul> | ||
| <li class="globals "> | ||
| <a href="../globals.html"><em>Globals</em></a> | ||
| </li> | ||
| <li class="current tsd-kind-module"> | ||
| <a href="_debounce_.html">"debounce"</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| <nav class="tsd-navigation secondary menu-sticky"> | ||
| <ul class="before-current"> | ||
| <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"> | ||
| <a href="_debounce_.html#debounce" class="tsd-kind-icon">debounce</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <footer class="with-border-bottom"> | ||
| <div class="container"> | ||
| <h2>Legend</h2> | ||
| <div class="tsd-legend-group"> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li> | ||
| <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> | ||
| <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> | ||
| <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> | ||
| <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> | ||
| <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> | ||
| </ul> | ||
| <ul class="tsd-legend"> | ||
| <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> | ||
| <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| <div class="container tsd-generator"> | ||
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> | ||
| </div> | ||
| <div class="overlay"></div> | ||
| <script src="../assets/js/main.js"></script> | ||
| <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.