Skip to content

Commit 4e606e5

Browse files
committed
add jsdocs for generateRandomName instead of tests
1 parent 79d9a4b commit 4e606e5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

client/utils/generateRandomName.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
import friendlyWords from 'friendly-words';
22

3+
/**
4+
* Generates a random friendly project name composed of an adjective and an object.
5+
* @example
6+
* generateProjectName(); // "brave mountain"
7+
*/
38
export function generateProjectName(): string {
49
const adj =
510
friendlyWords.predicates[
@@ -12,6 +17,11 @@ export function generateProjectName(): string {
1217
return `${adj} ${obj}`;
1318
}
1419

20+
/**
21+
* Generates a random friendly collection name using an adjective.
22+
* @example
23+
* generateCollectionName(); // "My clever collection"
24+
*/
1525
export function generateCollectionName(): string {
1626
const adj =
1727
friendlyWords.predicates[

0 commit comments

Comments
 (0)