From caafb906a0ef0eaaee3b96b04b07f18da3708bfa Mon Sep 17 00:00:00 2001
From: azabroflovski <azabroflovski@gmail.com>
Date: Wed, 11 May 2022 15:11:27 +0500
Subject: [PATCH] refactor(lib): add jsdoc to MXIKSearch

---
 src/lib/index.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/lib/index.ts b/src/lib/index.ts
index 4fa2c2f..c0bd11c 100644
--- 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 })