generate words starting with letter #42
Conversation
SuryanshuTomar
changed the title
There was a problem hiding this comment.
Thank you for the contribution!
This feature should be added as an enhancement to the existing generate function's options, so that it may be combined with other options. Also there no need to document it as a restriction to just one letter, as indeed your code already works with a longer prefix if a longer prefix is passed.
So I recommend naming the new option prefix and integrating it into the existing logic, rather than making a more limited standalone function that can't be combined with other functionality.
|
@boutell Here is the updated video - recording-2023-08-20-124311_SGeuChJa.mp4 |
|
Howdy @SuryanshuTomar - |
| let result = null; | ||
|
|
||
| // Filter the wordList to find words starting with the specified prefix | ||
| if (prefix) { |
There was a problem hiding this comment.
Let's make sure it's a string:
if (typeof prefix === 'string')
| const randomIndex = Math.floor(Math.random() * filteredList.length); | ||
| result = filteredList[randomIndex]; | ||
| } | ||
| } |
There was a problem hiding this comment.
} else { (follow our style for if/else whitespace)
| ## UNRELEASED | ||
|
|
||
| Added Function generateRandomWordStartingWith() | ||
| - That will take a string an input. |
There was a problem hiding this comment.
Needs a new changelog entry mentioning the new option.
| const filteredList = wordList.filter((word) => | ||
| word.startsWith(prefix) | ||
| ); | ||
| if (filteredList.length > 0) { |
There was a problem hiding this comment.
Throw an exception (throw new Error('Unavailable')) if no words are available meeting the criteria.
| @@ -1986,14 +1988,31 @@ export function generate(options) { | |||
| let rightSize = false; | |||
| let wordUsed; | |||
| while (!rightSize) { | |||
| wordUsed = generateRandomWord(); | |||
| // Generate a random word with the provided prefix (if any) | |||
| wordUsed = generateRandomWord(prefix); | |||
There was a problem hiding this comment.
While it was already possible in this loop, adding prefix increases the likelihood that we'll never find a word and get stuck in an infinite loop, which is problematic for sure. So please refactor generateRandomWord to also take min and max and include them in your filter criteria. That way we will know if it's impossible to satisfy the request due to any combination of min, max and prefix and can throw one clean exception. And this "rightSize" while loop can go away.
Probably generateRandomWord should just be merged with this function.
Summary
Summarize the changes briefly, including which issue/ticket this resolves. If it closes an existing Github issue, include "Closes #[issue number]"
What are the specific steps to test this change?
For example:
What kind of change does this PR introduce?
(Check at least one)
Make sure the PR fulfills these requirements:
If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.
Other information:
Work Done -
Created the function
generateRandomWordStartingWithwhich will take a letter or a word and will return a random word from the list of word already present in the file. In case, an invalid input is given then, the function will returnnull.Next PR - NA
Video -
indexjs-random-words-visual-studio-code-2023-07-14-20-28-07_nJ1iawRO.mp4