Skip to content

Commit

Permalink
docs(md): throttleOptions (leading)
Browse files Browse the repository at this point in the history
  • Loading branch information
wangcch committed Apr 16, 2020
1 parent e2bc467 commit 6efabfc
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@ yarn add @react-cmpt/use-throttle

throttle value

| option | type | default | explain |
| ------ | ------ | ------- | ------- |
| value | any | | |
| wait | number | 0 | |
| option | type | default | explain |
| ------- | -------------------- | ------- | --------------------------------------------------- |
| value | any | | |
| wait | number | 0 | |
| options | { leading: boolean } | | Specify invoking on the leading edge of the timeout |

| return | type | default | explain |
| ------ | ---- | ------------- | ------- |
Expand All @@ -41,10 +42,11 @@ const Demo = ({ value }) => {

throttle function

| option | type | default | explain |
| ------ | -------- | ------- | ------- |
| fn | function | | |
| wait | number | 0 | |
| option | type | default | explain |
| ------- | -------------------- | ------- | --------------------------------------------------- |
| fn | function | | |
| wait | number | 0 | |
| options | { leading: boolean } | | Specify invoking on the leading edge of the timeout |

| return | type | default | explain |
| -------- | -------- | ------- | ------- |
Expand Down

0 comments on commit 6efabfc

Please sign in to comment.