docs(useSetState): add resetState fn

alibaba · Jan 10, 2024 · d427856 · d427856
1 parent 3e7e7b6
commit d427856
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 10 deletions.
diff --git a/packages/hooks/src/useSetState/index.en-US.md b/packages/hooks/src/useSetState/index.en-US.md
@@ -20,15 +20,16 @@ useSetState works similar to `this.setState` of class component, used to manage
 ## API
 
 ```typescript
-const [state, setState] = useSetState<T>(initialState);
+const [state, setState, resetState] = useSetState<T>(initialState);
 ```
 
 ### Result
 
-| Property | Description          | Type                                                                                      | Default |
-| -------- | -------------------- | ----------------------------------------------------------------------------------------- | ------- |
-| state    | Current state        | `T`                                                                                       | -       |
-| setState | Update current state | `(state: Partial<T> \| null) => void` \| `((prevState: T) => Partial<T> \| null) => void` | -       |
+| Property   | Description          | Type                                                                                      | Default |
+| ---------- | -------------------- | ----------------------------------------------------------------------------------------- | ------- |
+| state      | Current state        | `T`                                                                                       | -       |
+| setState   | Update current state | `(state: Partial<T> \| null) => void` \| `((prevState: T) => Partial<T> \| null) => void` | -       |
+| resetState | Reset current state  | `() => void`                                                                              | -       |
 
 ### Params
 

diff --git a/packages/hooks/src/useSetState/index.zh-CN.md b/packages/hooks/src/useSetState/index.zh-CN.md
@@ -20,15 +20,16 @@ nav:
 ## API
 
 ```typescript
-const [state, setState] = useSetState<T>(initialState);
+const [state, setState, resetState] = useSetState<T>(initialState);
 ```
 
 ### Result
 
-| 参数     | 说明         | 类型                                                                                      | 默认值 |
-| -------- | ------------ | ----------------------------------------------------------------------------------------- | ------ |
-| state    | 当前状态     | `T`                                                                                       | -      |
-| setState | 设置当前状态 | `(state: Partial<T> \| null) => void` \| `((prevState: T) => Partial<T> \| null) => void` | -      |
+| 参数       | 说明         | 类型                                                                                      | 默认值 |
+| ---------- | ------------ | ----------------------------------------------------------------------------------------- | ------ |
+| state      | 当前状态     | `T`                                                                                       | -      |
+| setState   | 设置当前状态 | `(state: Partial<T> \| null) => void` \| `((prevState: T) => Partial<T> \| null) => void` | -      |
+| resetState | 重置当前状态 | `() => void`                                                                              | -      |
 
 ### Params