diff --git a/.changeset/usemap-optional-initial-state.md b/.changeset/usemap-optional-initial-state.md new file mode 100644 index 00000000..92a3b94d --- /dev/null +++ b/.changeset/usemap-optional-initial-state.md @@ -0,0 +1,5 @@ +--- +'react-simplikit': patch +--- + +Mark `useMap`'s `initialState` parameter as optional in the JSDoc and documentation, matching its existing default of `new Map()`. diff --git a/packages/plugin/skills/react-simplikit/references/useMap.md b/packages/plugin/skills/react-simplikit/references/useMap.md index ab50cf3d..b53e4782 100644 --- a/packages/plugin/skills/react-simplikit/references/useMap.md +++ b/packages/plugin/skills/react-simplikit/references/useMap.md @@ -6,13 +6,14 @@ Provides efficient state management and stable action functions. ## Interface ```ts -function useMap(initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### Parameters (initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### Parámetros (initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### パラメータ (initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### 파라미터 (initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### Parameters = [Omit, 'set' | 'clear' | 'delete'>, MapActio * * @template K - The type of the Map keys. * @template V - The type of the Map values. - * @param {MapOrEntries} initialState - Initial Map state (Map object or array of key-value pairs) + * @param {MapOrEntries} [initialState=new Map()] - Initial Map state (Map object or array of key-value pairs) * @returns {UseMapReturn} A tuple containing the Map state and actions to manipulate it * * @example diff --git a/packages/react-simplikit/src/hooks/useMap/zh-Hans/useMap.md b/packages/react-simplikit/src/hooks/useMap/zh-Hans/useMap.md index a36d74e9..088139c5 100644 --- a/packages/react-simplikit/src/hooks/useMap/zh-Hans/useMap.md +++ b/packages/react-simplikit/src/hooks/useMap/zh-Hans/useMap.md @@ -5,13 +5,14 @@ ## 接口 ```ts -function useMap(initialState: MapOrEntries): UseMapReturn; +function useMap( + initialState: MapOrEntries = new Map() +): UseMapReturn; ``` ### 参数