Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: @defaultValue of immediate of useTimeout/useTimeoutFn #120

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/core/src/useTimeout/interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface UseTimeoutOptions {
/**
* @en Start the timer immediate after calling this function
* @zh 立即设置定时器
* @defaultValue false
* @defaultValue true
*/
immediate?: boolean
}
2 changes: 1 addition & 1 deletion packages/core/src/useTimeoutFn/interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface UseTimeoutFnOptions {
/**
* @en Start the timer immediate after calling this function
* @zh 立即设置定时器
* @defaultValue false
* @defaultValue true
*/
immediate?: boolean
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@

|参数名|描述|类型|默认值|
|---|---|---|---|
|immediate|立即设置定时器|boolean |`false`|
|immediate|立即设置定时器|boolean |`true`|
2 changes: 1 addition & 1 deletion packages/website-docusaurus/api/useTimeout-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@

|Property|Description|Type|DefaultValue|
|---|---|---|---|
|immediate|Start the timer immediate after calling this function|boolean |`false`|
|immediate|Start the timer immediate after calling this function|boolean |`true`|
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@

|参数名|描述|类型|默认值|
|---|---|---|---|
|immediate|立即设置定时器|boolean |`false`|
|immediate|立即设置定时器|boolean |`true`|
2 changes: 1 addition & 1 deletion packages/website-docusaurus/api/useTimeoutFn-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@

|Property|Description|Type|DefaultValue|
|---|---|---|---|
|immediate|Start the timer immediate after calling this function|boolean |`false`|
|immediate|Start the timer immediate after calling this function|boolean |`true`|
Loading