Skip to content
This repository was archived by the owner on Apr 5, 2024. It is now read-only.

Commit 9979757

Browse files
committed
add docComments for PasswordStrengthBar
1 parent 5292a82 commit 9979757

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/components/pages/User/PasswordStrengthBar.tsx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ const PasswordStrengthBar = React.lazy(
77
)
88

99
/**
10+
* PasswordStrengthBarWrapper component's parameter type.
1011
* @typedef {Object} PasswordStrengthBarWrapperArgs
11-
* @property {string} currentPassword
12-
* @property {(number, PasswordFeedback) => void} scoreChangeCallback
12+
* @property {string} currentPassword The password to check.
13+
* @property {(number, PasswordFeedback) => void} scoreChangeCallback A function which receives the password's strength and reacts to it.
1314
*/
1415
type PasswordStrengthBarWrapperArgs = {
1516
currentPassword: string

0 commit comments

Comments
 (0)