Skip to content

Commit c7f94be

Browse files
committed
refactor(test): Move suggestUnDupTitle tests into JSDoc comments
1 parent 0772b41 commit c7f94be

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

websocket/suggestUnDupTitle.test.ts

Lines changed: 0 additions & 10 deletions
This file was deleted.

websocket/suggestUnDupTitle.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/**
2+
* Suggest a new title that is already in use.
3+
*
4+
* ```ts
5+
* import { assertEquals } from "@std/assert/equals";
6+
*
7+
* assertEquals(suggestUnDupTitle("title"), "title_2");
8+
* assertEquals(suggestUnDupTitle("title_2"), "title_3");
9+
* assertEquals(suggestUnDupTitle("title_10"), "title_11");
10+
* assertEquals(suggestUnDupTitle("title_10_3"), "title_10_4");
11+
* assertEquals(suggestUnDupTitle("another_title_5"), "another_title_6");
12+
* ```
13+
*
14+
* @param title - The title to suggest a new name for
15+
* @returns
16+
*/
117
export const suggestUnDupTitle = (title: string): string => {
218
const matched = title.match(/(.+?)(?:_(\d+))?$/);
319
const title_ = matched?.[1] ?? title;

0 commit comments

Comments
 (0)