feat: 유틸 함수 JSDoc 추가

seokzin · Dec 11, 2022 · c4c3753 · c4c3753
1 parent b7e8e77
commit c4c3753
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/utils/add.ts b/utils/add.ts
@@ -1,3 +1,8 @@
+/**
+ * Adds numbers together
+ * @param args Number list
+ * @returns The sum of number list
+ */
 const add = (...args: number[]) => [...args].reduce((a, b) => a + b);
 
 export default add;
diff --git a/utils/bfs.ts b/utils/bfs.ts
@@ -1,3 +1,9 @@
+/**
+ * Breadth-first search
+ * @param graph - Graph to search
+ * @param node - Node to start search from
+ * @returns Visited nodes
+ */
 const bfs = (graph: { [key: string]: string[] }, node: string) => {
   const queue = [node];
   const visited = [];

diff --git a/utils/binarySearch.ts b/utils/binarySearch.ts
@@ -1,3 +1,9 @@
+/**
+ * Binary search
+ * @param list - Number list to search
+ * @param callback - Callback function to compare
+ * @returns Index of the number
+ */
 const binarySearch = (list: number[], callback) => {
   let start = 0;
   let end = list.length - 1;