Skip to content

Commit 94f8826

Browse files
docs(useCounter): auto-generated docs (#232)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: seungrodotlee <[email protected]>
1 parent aa7c3d8 commit 94f8826

File tree

2 files changed

+16
-20
lines changed

2 files changed

+16
-20
lines changed

src/hooks/useCounter/ko/useCounter.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# useCounter
22

3-
`useCounter`숫자 카운터 상태를 증가, 감소, 초기화 기능과 함께 관리하는 리액트 훅이에요. 선택적으로, 카운터의 범위를 제한하기 위해 최소 및 최대값을 제공할 수 있어요.
3+
`useCounter`는 증가, 감소초기화 기능을 가진 숫자 카운터 상태를 관리하는 리액트 훅이에요. 선택적으로, 카운터의 범위를 제한하기 위해 최소값과 최대값을 제공할 수 있어요.
44

55
## Interface
66

77
```ts
88
function useCounter(
9-
initialValue?: number,
10-
options?: UseCounterOptions
9+
initialValue: number = 0,
10+
options: UseCounterOptions
1111
): UseCounterReturn;
1212
```
1313

@@ -16,30 +16,28 @@ function useCounter(
1616
<Interface
1717
name="initialValue"
1818
type="number"
19-
required={false}
20-
defaultValue="0"
2119
description="카운터의 초기값이에요. 기본값은 0이에요."
2220
/>
2321

2422
<Interface
23+
required
2524
name="options"
2625
type="UseCounterOptions"
27-
required={false}
2826
description="카운터의 옵션이에요."
2927
:nested="[
3028
{
3129
name: 'options.min',
3230
type: 'number',
3331
required: false,
3432
description:
35-
'카운터가 도달할 수 있는 최소값이에요. 제공되지 않으면 하한선이 없어요.',
33+
'카운터가 도달할 수 있는 최소값이에요. 제공되지 않으면, 하한선이 없어요.',
3634
},
3735
{
3836
name: 'options.max',
3937
type: 'number',
4038
required: false,
4139
description:
42-
'카운터가 도달할 수 있는 최대값이에요. 제공되지 않으면 상한선이 없어요.',
40+
'카운터가 도달할 수 있는 최대값이에요. 제공되지 않으면, 상한선이 없어요.',
4341
},
4442
{
4543
name: 'options.step',
@@ -56,7 +54,7 @@ function useCounter(
5654
<Interface
5755
name=""
5856
type="UseCounterReturn"
59-
description="카운트 값과 제어 함수들이 포함된 객체에요."
57+
description="카운트 값과 제어 함수들을 가진 객체예요."
6058
:nested="[
6159
{
6260
name: 'count',
@@ -68,26 +66,26 @@ function useCounter(
6866
name: 'increment',
6967
type: '() => void',
7068
required: false,
71-
description: '카운트를 증가시키는 함수에요.',
69+
description: '카운트를 증가시키는 함수예요.',
7270
},
7371
{
7472
name: 'decrement',
7573
type: '() => void',
7674
required: false,
77-
description: '카운트를 감소시키는 함수에요.',
75+
description: '카운트를 감소시키는 함수예요.',
7876
},
7977
{
8078
name: 'reset',
8179
type: '() => void',
8280
required: false,
83-
description: '카운트를 초기 값으로 리셋하는 함수에요.',
81+
description: '카운트를 초기값으로 재설정하는 함수예요.',
8482
},
8583
{
8684
name: 'setCount',
8785
type: '(value: number | ((prev: number) => number)) => void',
8886
required: false,
8987
description:
90-
'카운트를 특정 값으로 설정하거나 새로운 값을 반환하는 함수에요.',
88+
'카운트를 특정 값으로 설정하거나 새로운 값을 반환하는 함수예요.',
9189
},
9290
]"
9391
/>
@@ -105,15 +103,15 @@ function ShoppingCart() {
105103

106104
return (
107105
<div>
108-
<span>Quantity: {count}</span>
106+
<span>수량: {count}</span>
109107
<button type="button" onClick={decrement}>
110108
-
111109
</button>
112110
<button type="button" onClick={increment}>
113111
+
114112
</button>
115113
<button type="button" onClick={reset}>
116-
Reset
114+
재설정
117115
</button>
118116
</div>
119117
);

src/hooks/useCounter/useCounter.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
```ts
88
function useCounter(
9-
initialValue?: number,
10-
options?: UseCounterOptions
9+
initialValue: number = 0,
10+
options: UseCounterOptions
1111
): UseCounterReturn;
1212
```
1313

@@ -16,15 +16,13 @@ function useCounter(
1616
<Interface
1717
name="initialValue"
1818
type="number"
19-
required={false}
20-
defaultValue="0"
2119
description="Initial value for the counter. Defaults to 0."
2220
/>
2321

2422
<Interface
23+
required
2524
name="options"
2625
type="UseCounterOptions"
27-
required={false}
2826
description="The options for the counter."
2927
:nested="[
3028
{

0 commit comments

Comments
 (0)