Skip to content

docs(useCounter): mark options as optional #551

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.

Sign up for GitHub

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

Merged
mnxmnz merged 2 commits into from
Oct 6, 2026
Merged

docs(useCounter): mark options as optional #551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4c64ce
docs(useCounter): mark options as optional
theluckystrike Oct 3, 2026
401cee9
Merge branch 'main' into docs/use-counter-optional-options
mnxmnz Oct 6, 2026
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
5 changes: 5 additions & 0 deletions .changeset/use-counter-optional-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'react-simplikit': patch
---

The JSDoc of `useCounter` now marks `options` as optional, matching its `= {}` default, so the generated API pages and the agent skill no longer list it as required.
3 changes: 1 addition & 2 deletions packages/plugin/skills/react-simplikit/references/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Optionally, you can provide minimum and maximum values to constrain the counter'
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -21,7 +21,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="The options for the counter."
Expand Down
3 changes: 1 addition & 2 deletions packages/react-simplikit/src/hooks/useCounter/es/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Opcionalmente, puedes proporcionar valores mínimo y máximo para limitar el ran
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -21,7 +21,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="Las opciones del contador."
Expand Down
3 changes: 1 addition & 2 deletions packages/react-simplikit/src/hooks/useCounter/ja/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -21,7 +21,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="カウンターのオプション。"
Expand Down
3 changes: 1 addition & 2 deletions packages/react-simplikit/src/hooks/useCounter/ko/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -20,7 +20,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="카운터의 옵션이에요."
Expand Down
3 changes: 1 addition & 2 deletions packages/react-simplikit/src/hooks/useCounter/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Optionally, you can provide minimum and maximum values to constrain the counter'
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -21,7 +21,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="The options for the counter."
Expand Down
2 changes: 1 addition & 1 deletion packages/react-simplikit/src/hooks/useCounter/useCounter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const validateValue = (value: number, { min, max }: Omit<UseCounterOptions, 'ste
* Optionally, you can provide minimum and maximum values to constrain the counter's range.
*
* @param {number} [initialValue=0] - Initial value for the counter. Defaults to 0.
* @param {UseCounterOptions} options - The options for the counter.
* @param {UseCounterOptions} [options] - The options for the counter.
* @param {number} [options.min] - Minimum value the counter can reach. If not provided, there is no lower limit.
* @param {number} [options.max] - Maximum value the counter can reach. If not provided, there is no upper limit.
* @param {number} [options.step=1] - Value to increment or decrement by. Defaults to 1.
Expand Down
3 changes: 1 addition & 2 deletions packages/react-simplikit/src/hooks/useCounter/zh-Hans/useCounter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
```ts
function useCounter(
initialValue: number = 0,
options: UseCounterOptions
options?: UseCounterOptions
): UseCounterReturn;
```

Expand All @@ -20,7 +20,6 @@ function useCounter(
/>

<Interface
required
name="options"
type="UseCounterOptions"
description="计数器的选项。"
Expand Down
Loading