Skip to content

Repository files navigation

react-commit

lazily execute async functions on user initiated action

npm package

Usage

$ npm install react-commit --save
importCommitfrom'react-commit'
...
return(<Commitfn={RequestTempToken.commit}onMouseEnterdelayMs={500}cacheTime={60*1000}>{({ isLoading, retry, err, res })=>(<ButtononClick={()=>(err||!res ? retry() : this.onClick(res))}disabled={disabled ? disabled : isLoading}>{children}</Button>)}</Commit>)

API

ParamTypefunctionalityrequired
fnFunctionfunction to executetrue
childrenFunctionreceive {isLoading, retry, err, res}true
delayMsmilisecondsminimum time to be isLoading = truefalse
cacheTimemilisecondstime to cache res before invoking fn againfalse
onMouseEnterBooleanwhether to invoke fn on mouseEnterfalse
onClickBooleanwhether to invoke fn on onClickfalse

Questions? Feedback? Please let me know

License (MIT)

WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|

Copyright © 2017-present Jack Hanfordjackhanford@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

lazily execute async functions on user initiated action

Topics

Resources

Contributing

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages