refactor(lib): add jsdoc to MXIKSearch

azabroflovski · May 11, 2022 · caafb90 · caafb90
1 parent 8134e2e
commit caafb90
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/lib/index.ts b/src/lib/index.ts
@@ -1,6 +1,12 @@
 import { MXIKSearchSymbol } from '../api'
 import { MXIKSearchOptionsObj, MXIKSearchResponseObj } from '../typings'
 
+/**
+ * Search items by keyword
+ * @param keyword {string}
+ * @param limit {number}
+ * @returns {Promise<MXIKSearchResponseObj>}
+ */
 export async function MXIKSearch(keyword: string, { limit }: MXIKSearchOptionsObj): Promise<MXIKSearchResponseObj> {
  try {
  const { data: response } = await MXIKSearchSymbol({ keyword, limit })