Skip to content

Commit 6b765e3

Browse files
docs(useStorageState): auto-generated docs (#204)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: seungrodotlee <seungrodotlee@gmail.com>
1 parent 720e6ab commit 6b765e3

2 files changed

Lines changed: 46 additions & 8 deletions

File tree

src/hooks/useStorageState/ko/useStorageState.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ function useStorageState(
1111
): readonly [
1212
state: Serializable<T> | undefined,
1313
setState: (value: SetStateAction<Serializable<T> | undefined>) => void,
14+
refreshState: () => void,
1415
];
1516
```
1617

@@ -20,27 +21,39 @@ function useStorageState(
2021
required
2122
name="key"
2223
type="string"
23-
description="저장소에 값을 저장하는 데 사용되는 키예요."
24+
description="값을 저장소에 저장하기 위해 사용하는 키예요."
2425
/>
2526

2627
<Interface
2728
name="options"
2829
type="Object"
29-
description="저장 동작을 설정하는 옵션이에요."
30+
description="저장소 동작을 설정하는 옵션이에요."
3031
:nested="[
3132
{
3233
name: 'options.storage',
3334
type: 'Storage',
3435
required: false,
3536
defaultValue: 'localStorage',
3637
description:
37-
'저장소의 유형 (<code>localStorage</code> 또는 <code>sessionStorage</code>)이에요. 기본값은 <code>localStorage</code>예요.',
38+
'스토리지 타입 (<code>localStorage</code> 또는 <code>sessionStorage</code>). 기본값은 <code>localStorage</code>예요.',
3839
},
3940
{
4041
name: 'options.defaultValue',
4142
type: 'T',
4243
required: false,
43-
description: '기존 값이 발견되지 않을 경우의 초기 값이에요.',
44+
description: '기존의 값을 찾을 수 없을 때의 초기 값이에요.',
45+
},
46+
{
47+
name: 'options.serializer',
48+
type: 'Function',
49+
required: false,
50+
description: '상태 값을 문자열로 직렬화하는 함수예요.',
51+
},
52+
{
53+
name: 'options.deserializer',
54+
type: 'Function',
55+
required: false,
56+
description: '상태 값을 문자열에서 역직렬화하는 함수예요.',
4457
},
4558
]"
4659
/>
@@ -49,7 +62,7 @@ function useStorageState(
4962

5063
<Interface
5164
name=""
52-
type="readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]"
65+
type="readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void, refreshState: () => void]"
5366
description="튜플이에요:"
5467
:nested="[
5568
{
@@ -62,15 +75,21 @@ function useStorageState(
6275
name: 'setState',
6376
type: '(value: SetStateAction<Serializable<T> | undefined>) => void',
6477
required: false,
65-
description: '상태를 업데이트하고 저장하는 함수예요.',
78+
description: '상태를 업데이트하고 지속하는 함수예요.',
79+
},
80+
{
81+
name: 'refreshState',
82+
type: '() => void',
83+
required: false,
84+
description: '저장소에서 상태를 새롭게 고치는 함수예요.',
6685
},
6786
]"
6887
/>
6988

7089
## 예시
7190

7291
```tsx
73-
// 지속적인 상태를 가진 카운터
92+
// 지속되는 상태를 가진 카운터
7493
import { useStorageState } from 'react-simplikit';
7594

7695
function Counter() {

src/hooks/useStorageState/useStorageState.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ function useStorageState(
1111
): readonly [
1212
state: Serializable<T> | undefined,
1313
setState: (value: SetStateAction<Serializable<T> | undefined>) => void,
14+
refreshState: () => void,
1415
];
1516
```
1617

@@ -42,14 +43,26 @@ function useStorageState(
4243
required: false,
4344
description: 'The initial value if no existing value is found.',
4445
},
46+
{
47+
name: 'options.serializer',
48+
type: 'Function',
49+
required: false,
50+
description: 'A function to serialize the state value to a string.',
51+
},
52+
{
53+
name: 'options.deserializer',
54+
type: 'Function',
55+
required: false,
56+
description: 'A function to deserialize the state value from a string.',
57+
},
4558
]"
4659
/>
4760

4861
### Return Value
4962

5063
<Interface
5164
name=""
52-
type="readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void]"
65+
type="readonly [state: Serializable<T> | undefined, setState: (value: SetStateAction<Serializable<T> | undefined>) => void, refreshState: () => void]"
5366
description="tuple:"
5467
:nested="[
5568
{
@@ -64,6 +77,12 @@ function useStorageState(
6477
required: false,
6578
description: 'A function to update and persist the state.',
6679
},
80+
{
81+
name: 'refreshState',
82+
type: '() => void',
83+
required: false,
84+
description: 'A function to refresh the state from storage.',
85+
},
6786
]"
6887
/>
6988

0 commit comments

Comments
 (0)