Skip to content

Commit

Permalink
Fix tsdoc formatting & consistency
Browse files Browse the repository at this point in the history
Co-authored-by: Richard van der Hoff <[email protected]>
  • Loading branch information
dbkr and richvdh authored Jan 21, 2025
1 parent 8bffa39 commit ea67d39
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions src/randomstring.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,11 @@ export function secureRandomString(len: number): string {
}

/**
* Generate a cryptographically secure random string using characters given
* @param len The length of the string to generate (must be positive and less than 32768)
* @param chars The characters to use in the random string (between 2 and 256 characters long).
* @returns Random string of characters of length `len`
* Generate a cryptographically secure random string using characters given.
*
* @param len - The length of the string to generate (must be positive and less than 32768).
* @param chars - The characters to use in the random string (between 2 and 256 characters long).
* @returns Random string of characters of length `len`.
*/
export function secureRandomStringFrom(len: number, chars: string): string {
// This is intended for latin strings so 256 possibilities should be more than enough and
Expand Down

0 comments on commit ea67d39

Please sign in to comment.