UNPKG

aftool

Version:

aftool 个人用的一些基本库

331 lines 17.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>aftool</title> <meta name="description" content="Documentation for aftool"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </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">aftool</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> </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"> <h1>Project aftool</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>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class"><a href="classes/actioncontroller.html" class="tsd-kind-icon">Action<wbr>Controller</a></li> <li class="tsd-kind-class"><a href="classes/actionscontroller.html" class="tsd-kind-icon">Actions<wbr>Controller</a></li> <li class="tsd-kind-class"><a href="classes/arrayutil.html" class="tsd-kind-icon">Array<wbr>Util</a></li> <li class="tsd-kind-class"><a href="classes/keyutil.html" class="tsd-kind-icon">Key<wbr>Util</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface"><a href="interfaces/actioncontrollerparams.html" class="tsd-kind-icon">Action<wbr>Controller<wbr>Params</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias"><a href="modules.html#actionfunc" class="tsd-kind-icon">Action<wbr>Func</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#actionobject" class="tsd-kind-icon">Action<wbr>Object</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#actionscontrolleritem" class="tsd-kind-icon">Actions<wbr>Controller<wbr>Item</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function"><a href="modules.html#debounce" class="tsd-kind-icon">debounce</a></li> <li class="tsd-kind-function"><a href="modules.html#throttle" class="tsd-kind-icon">throttle</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="actionfunc" class="tsd-anchor"></a> <h3>Action<wbr>Func</h3> <div class="tsd-signature tsd-kind-icon">Action<wbr>Func<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">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L1">actionController.ts:1</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="actionobject" class="tsd-anchor"></a> <h3>Action<wbr>Object</h3> <div class="tsd-signature tsd-kind-icon">Action<wbr>Object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>action<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a><span class="tsd-signature-symbol">; </span>delay<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>func<span class="tsd-signature-symbol">?: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L3">actionController.ts:3</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>action<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h5> </li> <li class="tsd-parameter"> <h5>delay<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> func<span class="tsd-signature-symbol">?: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="actionscontrolleritem" class="tsd-anchor"></a> <h3>Actions<wbr>Controller<wbr>Item</h3> <div class="tsd-signature tsd-kind-icon">Actions<wbr>Controller<wbr>Item<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>action<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a><span class="tsd-signature-symbol">; </span>delay<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;debounce&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttle&quot;</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionsController.ts#L6">actionsController.ts:6</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>ActionControllers 构造函数中的配置项类型</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>action<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> delay<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> </li> <li class="tsd-parameter"> <h5><span class="tsd-flag ts-flagOptional">Optional</span> type<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;debounce&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttle&quot;</span></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function"> <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"> <li class="tsd-signature tsd-kind-icon">debounce<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a>, delay<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L66">actionController.ts:66</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>防抖函数</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fn: <a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h5> <div class="tsd-comment tsd-typography"> <p>要执行的主体函数</p> </div> </li> <li> <h5>delay: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>延迟ms为单位</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function"> <a name="throttle" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> throttle</h3> <ul class="tsd-signatures tsd-kind-function"> <li class="tsd-signature tsd-kind-icon">throttle<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a>, delay<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L83">actionController.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>节流函数</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>fn: <a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h5> <div class="tsd-comment tsd-typography"> <p>要执行的函数主体</p> </div> </li> <li> <h5>delay: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>延迟时间</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="modules.html#actionfunc" class="tsd-signature-type" data-tsd-kind="Type alias">ActionFunc</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="current "> <a href="modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="classes/actioncontroller.html" class="tsd-kind-icon">Action<wbr>Controller</a> </li> <li class=" tsd-kind-class"> <a href="classes/actionscontroller.html" class="tsd-kind-icon">Actions<wbr>Controller</a> </li> <li class=" tsd-kind-class"> <a href="classes/arrayutil.html" class="tsd-kind-icon">Array<wbr>Util</a> </li> <li class=" tsd-kind-class"> <a href="classes/keyutil.html" class="tsd-kind-icon">Key<wbr>Util</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/actioncontrollerparams.html" class="tsd-kind-icon">Action<wbr>Controller<wbr>Params</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#actionfunc" class="tsd-kind-icon">Action<wbr>Func</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#actionobject" class="tsd-kind-icon">Action<wbr>Object</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#actionscontrolleritem" class="tsd-kind-icon">Actions<wbr>Controller<wbr>Item</a> </li> <li class=" tsd-kind-function"> <a href="modules.html#debounce" class="tsd-kind-icon">debounce</a> </li> <li class=" tsd-kind-function"> <a href="modules.html#throttle" class="tsd-kind-icon">throttle</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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> </body> </html>