UNPKG

aftool

Version:

aftool 个人用的一些基本库

360 lines 17.7 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ActionController | 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"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">aftool</a> </li> <li> <a href="actioncontroller.html">ActionController</a> </li> </ul> <h1>Class ActionController</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>节流 防抖 对象</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ActionController</span> </li> </ul> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="actioncontroller.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="actioncontroller.html#debounceobj" class="tsd-kind-icon">debounce<wbr>Obj</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="actioncontroller.html#throttleobject" class="tsd-kind-icon">throttle<wbr>Object</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="actioncontroller.html#debounce" class="tsd-kind-icon">debounce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="actioncontroller.html#gowhat" class="tsd-kind-icon">go<wbr>What</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="actioncontroller.html#throttle" class="tsd-kind-icon">throttle</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Action<wbr>Controller<span class="tsd-signature-symbol">(</span>actionParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/actioncontrollerparams.html" class="tsd-signature-type" data-tsd-kind="Interface">ActionControllerParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="actioncontroller.html" class="tsd-signature-type" data-tsd-kind="Class">ActionController</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#L20">actionController.ts:20</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>actionParams: <a href="../interfaces/actioncontrollerparams.html" class="tsd-signature-type" data-tsd-kind="Interface">ActionControllerParams</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="actioncontroller.html" class="tsd-signature-type" data-tsd-kind="Class">ActionController</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="debounceobj" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> debounce<wbr>Obj</h3> <div class="tsd-signature tsd-kind-icon">debounce<wbr>Obj<span class="tsd-signature-symbol">:</span> <a href="../modules.html#actionobject" class="tsd-signature-type" data-tsd-kind="Type alias">ActionObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L35">actionController.ts:35</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="throttleobject" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> throttle<wbr>Object</h3> <div class="tsd-signature tsd-kind-icon">throttle<wbr>Object<span class="tsd-signature-symbol">:</span> <a href="../modules.html#actionobject" class="tsd-signature-type" data-tsd-kind="Type alias">ActionObject</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L36">actionController.ts:36</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="debounce" class="tsd-anchor"></a> <h3>debounce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">debounce<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"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L42">actionController.ts:42</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><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> <div class="tsd-comment tsd-typography"> <p>参数</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="gowhat" class="tsd-anchor"></a> <h3>go<wbr>What</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">go<wbr>What<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-symbol">(</span>actionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;debounceObj&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttleObject&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></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#L54">actionController.ts:54</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>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-symbol">(</span>actionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;debounceObj&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttleObject&quot;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>actionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;debounceObj&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttleObject&quot;</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>actionName: <span class="tsd-signature-type">&quot;debounceObj&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;throttleObject&quot;</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="throttle" class="tsd-anchor"></a> <h3>throttle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">throttle<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"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/yinxinp/aftool/blob/18c85f6/src/actionController.ts#L50">actionController.ts:50</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><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> <div class="tsd-comment tsd-typography"> <p>参数</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="actioncontroller.html" class="tsd-kind-icon">Action<wbr>Controller</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="actioncontroller.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="actioncontroller.html#debounceobj" class="tsd-kind-icon">debounce<wbr>Obj</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="actioncontroller.html#throttleobject" class="tsd-kind-icon">throttle<wbr>Object</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="actioncontroller.html#debounce" class="tsd-kind-icon">debounce</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="actioncontroller.html#gowhat" class="tsd-kind-icon">go<wbr>What</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="actioncontroller.html#throttle" class="tsd-kind-icon">throttle</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class"> <a href="actionscontroller.html" class="tsd-kind-icon">Actions<wbr>Controller</a> </li> <li class=" tsd-kind-class"> <a href="arrayutil.html" class="tsd-kind-icon">Array<wbr>Util</a> </li> <li class=" tsd-kind-class"> <a href="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>