add example and explaination

Nursid · Nursid · commit c8b8291ebdc0 · 2024-06-04T19:34:55.000+05:30
diff --git a/docs/api/chat/eventEmitter.md b/docs/api/chat/eventEmitter.md
diff --git a/docs/api/chat/userMessageListener.md b/docs/api/chat/userMessageListener.md
@@ -15,4 +15,7 @@ data:
   link: userMessageListener.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+Working Progress....
diff --git a/docs/api/chat/waitforReply.md b/docs/api/chat/waitforReply.md
@@ -19,4 +19,17 @@ data:
   link: waitforReply.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example: 
+
+```js
+
+const message = await codebolt.chat.waitforReply(message: string)
+
+```
+
+### Explaination 
+
+The codebolt.chat.waitforReply(message: string) function is used to send a message  on the codebolt chat and wait for the reply. This function enables real-time communication by allowing the script to send text messages on the codebolt chat. This function returns the reply message, which we can store in a variable and use.
+
diff --git a/docs/api/codeparsers/getAstTreeInFile.md b/docs/api/codeparsers/getAstTreeInFile.md
@@ -20,4 +20,8 @@ data:
   link: getAstTreeInFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status
+
+Working Progress...
diff --git a/docs/api/codeparsers/getClassesInFile.md b/docs/api/codeparsers/getClassesInFile.md
@@ -17,4 +17,8 @@ data:
   link: getClassesInFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...
diff --git a/docs/api/codeparsers/getFunctionsinClass.md b/docs/api/codeparsers/getFunctionsinClass.md
@@ -20,4 +20,8 @@ data:
   link: getFunctionsinClass.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...
diff --git a/docs/api/codeutils/getAllFilesAsMarkDown.md b/docs/api/codeutils/getAllFilesAsMarkDown.md
@@ -16,4 +16,31 @@ data:
   link: getAllFilesAsMarkDown.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example
+
+```js
+
+////test.js 
+
+function foo(d) {
+  d += 3;
+    return d+999
+}
+function bar(d) {
+    return d*100
+}
+
+
+///index.js
+
+const getAllFilesAsMarkDown = await codebolt.codeutils.getAllFilesAsMarkDown();
+
+```
+
+![markdown](../../../static/img/markdown.png)
+
+### Explaination 
+
+The codebolt.codeutils.getAllFilesAsMarkDown() function is used the Retrieves all files as Markdown. This Function returns the File as markdown, which we can store in a variable and use.
diff --git a/docs/api/codeutils/getJsTree.md b/docs/api/codeutils/getJsTree.md
@@ -19,4 +19,17 @@ data:
   link: getJsTree.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Examples 
+
+```js 
+
+const GetJsTree = await codebolt.codeutils.getJsTree();
+
+```
+
+
+### Explaination
+
+The method codebolt.codeutils.getJsTree(filePath: string) is designed to analyze a JavaScript file located at the given file path and return its tree structure. This tree structure is a hierarchical representation of the code within the file, which typically includes various elements such as functions, variables, classes, etc.
diff --git a/docs/api/codeutils/getMatcherList.md b/docs/api/codeutils/getMatcherList.md
@@ -16,4 +16,7 @@ data:
   link: getMatcherList.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+Working Progress..
diff --git a/docs/api/codeutils/matchDetail.md b/docs/api/codeutils/matchDetail.md
@@ -19,4 +19,8 @@ data:
   link: matchDetail.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/codeutils/performMatch.md b/docs/api/codeutils/performMatch.md
@@ -25,4 +25,7 @@ data:
   link: performMatch.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/click.md b/docs/api/crawler/click.md
@@ -19,4 +19,7 @@ data:
   link: click.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/crawl.md b/docs/api/crawler/crawl.md
@@ -14,4 +14,8 @@ data:
   link: crawl.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/enter.md b/docs/api/crawler/enter.md
@@ -14,4 +14,8 @@ data:
   link: enter.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/goToPage.md b/docs/api/crawler/goToPage.md
@@ -17,4 +17,8 @@ data:
   link: goToPage.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/screenshot.md b/docs/api/crawler/screenshot.md
@@ -14,4 +14,8 @@ data:
   link: screenshot.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/scroll.md b/docs/api/crawler/scroll.md
@@ -17,4 +17,8 @@ data:
   link: scroll.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/start.md b/docs/api/crawler/start.md
@@ -14,4 +14,8 @@ data:
   link: start.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+Working Progress..
diff --git a/docs/api/crawler/type.md b/docs/api/crawler/type.md
@@ -22,4 +22,7 @@ data:
   link: type.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+Working Progress..
diff --git a/docs/api/dbmemory/addKnowledge.md b/docs/api/dbmemory/addKnowledge.md
@@ -22,4 +22,25 @@ data:
   link: addKnowledge.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example
+
+```js 
+
+// Add a key-value pair to the in-memory database with the key "UserID" and the value "admin"
+await codebolt.dbmemory.addKnowledge("UserID", "admin")
+
+// Add a key-value pair to the in-memory database with the key "Password" and the value "Test@123"
+await codebolt.dbmemory.addKnowledge("Password", "Test@123")
+
+```
+
+
+### Explaination 
+
+Adding a key-value pair to an in-memory database involves storing a specific piece of information (value) that can be retrieved later using a unique identifier (key).
+
+Key: A unique identifier, typically a string, that is used to reference the data.
+
+Value: The actual data or information that you want to store. This can be any type of data, such as a number, a string, an object, etc.
diff --git a/docs/api/dbmemory/getKnowledge.md b/docs/api/dbmemory/getKnowledge.md
@@ -19,4 +19,27 @@ data:
   link: getKnowledge.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js 
+
+//set the userID and password 
+const UserID = await codebolt.dbmemory.getKnowledge("UserID")
+const Password = await codebolt.dbmemory.getKnowledge("Passowrd")
+
+console.log("UserId------",UserID);
+console.log("Password------",Password);
+
+///output
+
+///UserId------ admin
+///Password----- Test@123
+
+```
+
+### Explaination
+
+The getKnowledge method retrieves the value associated with a given key from the in-memory database, allowing you to access stored information using the unique identifier provided.
+
diff --git a/docs/api/debug/debug.md b/docs/api/debug/debug.md
@@ -22,4 +22,25 @@ data:
   link: debug.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Example
+
+```js
+//error is a varialbe that stored error log 
+const error = "error log"
+
+//// Calling the `codebolt.debug.debug` method to log the error with its type (e.g., "warning", "error", etc.)
+const fileData = await codebolt.debug.debug(error, "error")
+
+//after executing this command then show the error in debug section on coltbolt.
+
+```
+
+![debug](../../../static/img/debug.png)
+
+
+### Explaination
+
+While executing the codebolt.debug.debug method, the error will be shown in the debug section of Codebolt.
diff --git a/docs/api/debug/openDebugBrowser.md b/docs/api/debug/openDebugBrowser.md
@@ -24,4 +24,9 @@ data:
   link: openDebugBrowser.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### status 
+
+Working Progress...
diff --git a/static/img/debug.png b/static/img/debug.png
diff --git a/static/img/fileMarkDown.png b/static/img/fileMarkDown.png
diff --git a/static/img/markdown.png b/static/img/markdown.png
