Skip to content

Commit fc9c0b0

Browse files
CBID2babblebey
andauthored
docs(word-editor): update jsdoc types in useWordEditor hook (#230)
## Description <!-- Please add PR description (don't leave blank) - example: This PR [adds/removes/fixes/replaces] the [feature/bug/etc] --> This PR updates replaces the Jsdoc types in `useWordEditor` hook, making it easier for developers understand the hook's API. ## Related Issue <!-- Please prefix the issue number with Fixes/Resolves - example: Fixes #123 or Resolves #123 --> Fixes #201 ## Screenshots/Screencasts <!-- Please provide screenshots or video recording that demos your changes (especially if it's a visual change) --> N/A ## Notes to Reviewer <!-- Please state here if you added a new npm packages, or any extra information that can help reviewer better review you changes --> This is my first contribution to this project(and my first PR for this year's Hacktoberfest), so any feedback is appreciated! :) --------- Signed-off-by: Christine <shecoder30@gmail.com> Co-authored-by: Olabode Lawal-Shittabey <babblebey@gmail.com>
1 parent 84727f0 commit fc9c0b0

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

src/lib/hooks/use-word-editor.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { $wordEditor } from "../stores/dictionary.js";
33

44
/**
55
* Custom hook serves as wrapper around `wordEditor` map store
6-
* @returns {{ title: string, content: string, setTitle: (title: string) => void, setContent: (content: string) => void }}
6+
* @returns {{ title: string, content: string, initialContent: string, setTitle: (title: string) => void, setContent: (content: string) => void, setInitialContent: (content: string) => void }}
77
*/
88
export default function useWordEditor() {
99
const word = useStore($wordEditor);

0 commit comments

Comments
 (0)