@codebolt/codeboltjs 2.0.2 → 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (414) hide show
  1. package/Readme.md +47 -0
  2. package/{modules → dist}/agentlib/agent.js +63 -54
  3. package/{modules → dist}/agentlib/usermessage.js +3 -3
  4. package/{index.d.ts → dist/index.d.ts} +3 -0
  5. package/{index.js → dist/index.js} +2 -0
  6. package/dist/utils/editFile.d.ts +4 -0
  7. package/dist/utils/editFile.js +30 -0
  8. package/dist/utils.d.ts +5 -0
  9. package/{utils.js → dist/utils.js} +4 -4
  10. package/package.json +17 -8
  11. package/.codebolt/chat.json +0 -1
  12. package/.codebolt/debug.json +0 -1
  13. package/.codebolt/projectState.json +0 -127
  14. package/.codebolt/tasks.json +0 -1
  15. package/.codeboltconfig.yaml +0 -0
  16. package/.github/workflows/publish-to-npm.yml +0 -20
  17. package/bkp/toolBox.bkp.ts +0 -1162
  18. package/docs/.nojekyll +0 -1
  19. package/docs/assets/highlight.css +0 -127
  20. package/docs/assets/icons.js +0 -15
  21. package/docs/assets/icons.svg +0 -1
  22. package/docs/assets/main.js +0 -59
  23. package/docs/assets/navigation.js +0 -1
  24. package/docs/assets/search.js +0 -1
  25. package/docs/assets/style.css +0 -1412
  26. package/docs/classes/_internal_.Agent.html +0 -318
  27. package/docs/classes/_internal_.AsyncResource.html +0 -44
  28. package/docs/classes/_internal_.Blob.html +0 -33
  29. package/docs/classes/_internal_.ClientRequest.html +0 -506
  30. package/docs/classes/_internal_.Codebolt.html +0 -315
  31. package/docs/classes/_internal_.CustomEventEmitter-1.html +0 -248
  32. package/docs/classes/_internal_.CustomEventEmitter.html +0 -248
  33. package/docs/classes/_internal_.Duplex.html +0 -690
  34. package/docs/classes/_internal_.EventEmitter-1.html +0 -254
  35. package/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +0 -268
  36. package/docs/classes/_internal_.IncomingMessage.html +0 -661
  37. package/docs/classes/_internal_.KeyObject.html +0 -76
  38. package/docs/classes/_internal_.OutgoingMessage.html +0 -491
  39. package/docs/classes/_internal_.Readable.html +0 -551
  40. package/docs/classes/_internal_.ReadableBase.html +0 -551
  41. package/docs/classes/_internal_.Server-1.html +0 -416
  42. package/docs/classes/_internal_.Server-2.html +0 -326
  43. package/docs/classes/_internal_.Server-3.html +0 -353
  44. package/docs/classes/_internal_.Server.html +0 -390
  45. package/docs/classes/_internal_.ServerResponse.html +0 -569
  46. package/docs/classes/_internal_.Socket.html +0 -791
  47. package/docs/classes/_internal_.Stream.html +0 -256
  48. package/docs/classes/_internal_.TLSSocket.html +0 -947
  49. package/docs/classes/_internal_.URL.html +0 -140
  50. package/docs/classes/_internal_.URLSearchParams.html +0 -68
  51. package/docs/classes/_internal_.WebSocket-1.html +0 -297
  52. package/docs/classes/_internal_.WebSocket.Server.html +0 -261
  53. package/docs/classes/_internal_.Writable.html +0 -394
  54. package/docs/classes/_internal_.WritableBase.html +0 -394
  55. package/docs/classes/_internal_.X509Certificate.html +0 -144
  56. package/docs/classes/_internal_.internal-1.html +0 -256
  57. package/docs/classes/_internal_.internal.PassThrough.html +0 -686
  58. package/docs/classes/_internal_.internal.Transform.html +0 -693
  59. package/docs/enums/_internal_.logType.html +0 -4
  60. package/docs/functions/_internal_.WebSocket.createWebSocketStream.html +0 -1
  61. package/docs/functions/_internal_._node_stream_consumers_.arrayBuffer.html +0 -1
  62. package/docs/functions/_internal_._node_stream_consumers_.blob.html +0 -1
  63. package/docs/functions/_internal_._node_stream_consumers_.buffer.html +0 -1
  64. package/docs/functions/_internal_._node_stream_consumers_.json.html +0 -1
  65. package/docs/functions/_internal_._node_stream_consumers_.text.html +0 -1
  66. package/docs/functions/_internal_._node_stream_promises_.finished.html +0 -1
  67. package/docs/functions/_internal_._node_stream_promises_.pipeline.html +0 -1
  68. package/docs/functions/_internal_.internal.addAbortSignal.html +0 -17
  69. package/docs/functions/_internal_.internal.finished-1.html +0 -20
  70. package/docs/functions/_internal_.internal.finished.__promisify__.html +0 -1
  71. package/docs/functions/_internal_.internal.getDefaultHighWaterMark.html +0 -4
  72. package/docs/functions/_internal_.internal.isErrored.html +0 -3
  73. package/docs/functions/_internal_.internal.isReadable.html +0 -3
  74. package/docs/functions/_internal_.internal.pipeline-1.html +0 -24
  75. package/docs/functions/_internal_.internal.pipeline.__promisify__.html +0 -1
  76. package/docs/functions/_internal_.internal.setDefaultHighWaterMark.html +0 -4
  77. package/docs/hierarchy.html +0 -1
  78. package/docs/index.html +0 -12
  79. package/docs/interfaces/_internal_.AddToAgentStateResponse.html +0 -3
  80. package/docs/interfaces/_internal_.AddTokenResponse.html +0 -3
  81. package/docs/interfaces/_internal_.AddVectorItemResponse.html +0 -3
  82. package/docs/interfaces/_internal_.AddressInfo.html +0 -4
  83. package/docs/interfaces/_internal_.AgentOptions.html +0 -35
  84. package/docs/interfaces/_internal_.ApplicationState.html +0 -4
  85. package/docs/interfaces/_internal_.ArrayBufferView.html +0 -7
  86. package/docs/interfaces/_internal_.ArrayLike.html +0 -2
  87. package/docs/interfaces/_internal_.ArrayOptions.html +0 -7
  88. package/docs/interfaces/_internal_.AsymmetricKeyDetails.html +0 -15
  89. package/docs/interfaces/_internal_.AsyncGenerator.html +0 -5
  90. package/docs/interfaces/_internal_.AsyncGeneratorFunction.html +0 -12
  91. package/docs/interfaces/_internal_.AsyncIterable.html +0 -2
  92. package/docs/interfaces/_internal_.AsyncIterableIterator.html +0 -5
  93. package/docs/interfaces/_internal_.AsyncIterator.html +0 -4
  94. package/docs/interfaces/_internal_.AsyncResourceOptions.html +0 -12
  95. package/docs/interfaces/_internal_.BlobOptions.html +0 -8
  96. package/docs/interfaces/_internal_.Buffer.html +0 -760
  97. package/docs/interfaces/_internal_.BufferConstructor.html +0 -165
  98. package/docs/interfaces/_internal_.Certificate.html +0 -13
  99. package/docs/interfaces/_internal_.ChatMessage.html +0 -3
  100. package/docs/interfaces/_internal_.Choice.html +0 -5
  101. package/docs/interfaces/_internal_.CipherNameAndProtocol.html +0 -7
  102. package/docs/interfaces/_internal_.ClientRequestArgs.html +0 -28
  103. package/docs/interfaces/_internal_.CommandError.html +0 -3
  104. package/docs/interfaces/_internal_.CommonConnectionOptions.html +0 -29
  105. package/docs/interfaces/_internal_.ConnectOpts.html +0 -5
  106. package/docs/interfaces/_internal_.CreateFileResponse.html +0 -6
  107. package/docs/interfaces/_internal_.CreateFolderResponse.html +0 -6
  108. package/docs/interfaces/_internal_.CryptoKey.html +0 -26
  109. package/docs/interfaces/_internal_.DebugAddLogResponse.html +0 -4
  110. package/docs/interfaces/_internal_.DeleteFileResponse.html +0 -6
  111. package/docs/interfaces/_internal_.DeleteFolderResponse.html +0 -6
  112. package/docs/interfaces/_internal_.DetailedPeerCertificate.html +0 -53
  113. package/docs/interfaces/_internal_.Dict.html +0 -1
  114. package/docs/interfaces/_internal_.Disposable.html +0 -2
  115. package/docs/interfaces/_internal_.DropArgument.html +0 -7
  116. package/docs/interfaces/_internal_.DuplexOptions.html +0 -22
  117. package/docs/interfaces/_internal_.EphemeralKeyInfo.html +0 -7
  118. package/docs/interfaces/_internal_.ErrnoException.html +0 -8
  119. package/docs/interfaces/_internal_.Error.html +0 -4
  120. package/docs/interfaces/_internal_.EventEmitter-2.html +0 -130
  121. package/docs/interfaces/_internal_.EventEmitter.Abortable.html +0 -3
  122. package/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +0 -19
  123. package/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +0 -32
  124. package/docs/interfaces/_internal_.EventEmitterOptions.html +0 -3
  125. package/docs/interfaces/_internal_.ExtractTextResponse.html +0 -3
  126. package/docs/interfaces/_internal_.GetAgentStateResponse.html +0 -3
  127. package/docs/interfaces/_internal_.GetContentResponse.html +0 -3
  128. package/docs/interfaces/_internal_.GetMarkdownResponse.html +0 -3
  129. package/docs/interfaces/_internal_.GetMatcherListTreeResponse.html +0 -3
  130. package/docs/interfaces/_internal_.GetProjectPathResponse.html +0 -5
  131. package/docs/interfaces/_internal_.GetTokenResponse.html +0 -3
  132. package/docs/interfaces/_internal_.GetVectorResponse.html +0 -3
  133. package/docs/interfaces/_internal_.GoToPageResponse.html +0 -3
  134. package/docs/interfaces/_internal_.HtmlReceived.html +0 -3
  135. package/docs/interfaces/_internal_.IncomingHttpHeaders.html +0 -64
  136. package/docs/interfaces/_internal_.InformationEvent.html +0 -8
  137. package/docs/interfaces/_internal_.IpcSocketConnectOpts.html +0 -6
  138. package/docs/interfaces/_internal_.Iterable.html +0 -2
  139. package/docs/interfaces/_internal_.IterableIterator.html +0 -5
  140. package/docs/interfaces/_internal_.Iterator.html +0 -4
  141. package/docs/interfaces/_internal_.IteratorReturnResult.html +0 -3
  142. package/docs/interfaces/_internal_.IteratorYieldResult.html +0 -3
  143. package/docs/interfaces/_internal_.JsonWebKey.html +0 -14
  144. package/docs/interfaces/_internal_.JwkKeyExportOptions.html +0 -2
  145. package/docs/interfaces/_internal_.KeyAlgorithm.html +0 -2
  146. package/docs/interfaces/_internal_.KeyExportOptions.html +0 -5
  147. package/docs/interfaces/_internal_.KeyObject-1.html +0 -5
  148. package/docs/interfaces/_internal_.LLMResponse.html +0 -4
  149. package/docs/interfaces/_internal_.ListenOptions.html +0 -13
  150. package/docs/interfaces/_internal_.LookupAddress.html +0 -6
  151. package/docs/interfaces/_internal_.LookupOptions.html +0 -27
  152. package/docs/interfaces/_internal_.MatchProblemResponse.html +0 -3
  153. package/docs/interfaces/_internal_.MemoryGetResponse.html +0 -5
  154. package/docs/interfaces/_internal_.MemorySetResponse.html +0 -5
  155. package/docs/interfaces/_internal_.Message.html +0 -8
  156. package/docs/interfaces/_internal_.MessageContent.html +0 -3
  157. package/docs/interfaces/_internal_.Object.html +0 -18
  158. package/docs/interfaces/_internal_.OnReadOpts.html +0 -6
  159. package/docs/interfaces/_internal_.OpenDebugBrowserResponse.html +0 -4
  160. package/docs/interfaces/_internal_.OutgoingHttpHeaders.html +0 -80
  161. package/docs/interfaces/_internal_.PeerCertificate.html +0 -50
  162. package/docs/interfaces/_internal_.PromiseLike.html +0 -6
  163. package/docs/interfaces/_internal_.PxfObject.html +0 -5
  164. package/docs/interfaces/_internal_.QueryVectorItemResponse.html +0 -3
  165. package/docs/interfaces/_internal_.QueuingStrategy.html +0 -3
  166. package/docs/interfaces/_internal_.QueuingStrategySize.html +0 -1
  167. package/docs/interfaces/_internal_.ReadFileResponse.html +0 -7
  168. package/docs/interfaces/_internal_.ReadOnlyDict.html +0 -1
  169. package/docs/interfaces/_internal_.ReadWriteStream.html +0 -144
  170. package/docs/interfaces/_internal_.ReadableByteStreamController.html +0 -6
  171. package/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html +0 -1
  172. package/docs/interfaces/_internal_.ReadableOptions.html +0 -11
  173. package/docs/interfaces/_internal_.ReadableStream-1.html +0 -141
  174. package/docs/interfaces/_internal_.ReadableStream.html +0 -10
  175. package/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +0 -5
  176. package/docs/interfaces/_internal_.ReadableStreamDefaultController.html +0 -5
  177. package/docs/interfaces/_internal_.ReadableStreamDefaultReadDoneResult.html +0 -3
  178. package/docs/interfaces/_internal_.ReadableStreamDefaultReadValueResult.html +0 -3
  179. package/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +0 -5
  180. package/docs/interfaces/_internal_.ReadableStreamErrorCallback.html +0 -1
  181. package/docs/interfaces/_internal_.ReadableStreamGenericReader.html +0 -3
  182. package/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html +0 -3
  183. package/docs/interfaces/_internal_.ReadableStreamReadValueResult.html +0 -3
  184. package/docs/interfaces/_internal_.ReadableWritablePair.html +0 -9
  185. package/docs/interfaces/_internal_.SecureContext.html +0 -2
  186. package/docs/interfaces/_internal_.SecureContextOptions.html +0 -121
  187. package/docs/interfaces/_internal_.Selection.html +0 -6
  188. package/docs/interfaces/_internal_.ServerOptions.html +0 -64
  189. package/docs/interfaces/_internal_.ServerOpts.html +0 -25
  190. package/docs/interfaces/_internal_.SharedArrayBuffer.html +0 -7
  191. package/docs/interfaces/_internal_.SharedArrayBufferConstructor.html +0 -3
  192. package/docs/interfaces/_internal_.SocketConstructorOpts.html +0 -6
  193. package/docs/interfaces/_internal_.StaticEventEmitterOptions.html +0 -15
  194. package/docs/interfaces/_internal_.StreamOptions.html +0 -9
  195. package/docs/interfaces/_internal_.StreamPipeOptions.html +0 -37
  196. package/docs/interfaces/_internal_.TLSSocketOptions.html +0 -160
  197. package/docs/interfaces/_internal_.TcpSocketConnectOpts.html +0 -19
  198. package/docs/interfaces/_internal_.TerminalInterruptResponse.html +0 -3
  199. package/docs/interfaces/_internal_.TlsOptions.html +0 -197
  200. package/docs/interfaces/_internal_.UnderlyingByteSource.html +0 -6
  201. package/docs/interfaces/_internal_.UnderlyingSink.html +0 -6
  202. package/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html +0 -1
  203. package/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html +0 -1
  204. package/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html +0 -1
  205. package/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html +0 -1
  206. package/docs/interfaces/_internal_.UnderlyingSource.html +0 -5
  207. package/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html +0 -1
  208. package/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html +0 -1
  209. package/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html +0 -1
  210. package/docs/interfaces/_internal_.UpdateFileResponse.html +0 -6
  211. package/docs/interfaces/_internal_.UrlResponse.html +0 -3
  212. package/docs/interfaces/_internal_.Usage-1.html +0 -4
  213. package/docs/interfaces/_internal_.Usage.html +0 -4
  214. package/docs/interfaces/_internal_.UserMessage.html +0 -3
  215. package/docs/interfaces/_internal_.UserRequest.html +0 -7
  216. package/docs/interfaces/_internal_.WebSocket.AddressInfo.html +0 -4
  217. package/docs/interfaces/_internal_.WebSocket.ClientOptions.html +0 -138
  218. package/docs/interfaces/_internal_.WebSocket.CloseEvent.html +0 -6
  219. package/docs/interfaces/_internal_.WebSocket.ErrorEvent.html +0 -5
  220. package/docs/interfaces/_internal_.WebSocket.Event.html +0 -3
  221. package/docs/interfaces/_internal_.WebSocket.EventListenerOptions.html +0 -2
  222. package/docs/interfaces/_internal_.WebSocket.MessageEvent.html +0 -4
  223. package/docs/interfaces/_internal_.WebSocket.PerMessageDeflateOptions.html +0 -9
  224. package/docs/interfaces/_internal_.WebSocket.ServerOptions.html +0 -14
  225. package/docs/interfaces/_internal_.WebSocket.WebSocket.html +0 -172
  226. package/docs/interfaces/_internal_.WebSocket.WebSocketServer.html +0 -144
  227. package/docs/interfaces/_internal_.WebSocketAlias.html +0 -172
  228. package/docs/interfaces/_internal_.WritableOptions.html +0 -14
  229. package/docs/interfaces/_internal_.WritableStream-1.html +0 -8
  230. package/docs/interfaces/_internal_.WritableStream.html +0 -133
  231. package/docs/interfaces/_internal_.WritableStreamDefaultController.html +0 -6
  232. package/docs/interfaces/_internal_.WritableStreamDefaultWriter.html +0 -12
  233. package/docs/interfaces/_internal_.X509CheckOptions.html +0 -16
  234. package/docs/interfaces/_internal_.ZlibOptions.html +0 -21
  235. package/docs/interfaces/_internal_.getMatchDetail.html +0 -3
  236. package/docs/interfaces/_internal_.internal.FinishedOptions.html +0 -6
  237. package/docs/interfaces/_internal_.internal.Pipe.html +0 -5
  238. package/docs/interfaces/_internal_.internal.PipelineOptions.html +0 -3
  239. package/docs/interfaces/_internal_.internal.TransformOptions.html +0 -24
  240. package/docs/modules/_internal_.EventEmitter.html +0 -6
  241. package/docs/modules/_internal_.WebSocket.html +0 -21
  242. package/docs/modules/_internal_._node_stream_consumers_.html +0 -6
  243. package/docs/modules/_internal_._node_stream_promises_.html +0 -3
  244. package/docs/modules/_internal_.html +0 -228
  245. package/docs/modules/_internal_.internal.finished.html +0 -2
  246. package/docs/modules/_internal_.internal.html +0 -36
  247. package/docs/modules/_internal_.internal.pipeline.html +0 -2
  248. package/docs/modules.html +0 -3
  249. package/docs/types/_internal_.AnyRest.html +0 -1
  250. package/docs/types/_internal_.Args.html +0 -1
  251. package/docs/types/_internal_.ArrayBufferLike.html +0 -1
  252. package/docs/types/_internal_.ArrayBufferView-1.html +0 -1
  253. package/docs/types/_internal_.BinaryLike.html +0 -1
  254. package/docs/types/_internal_.BufferEncoding.html +0 -1
  255. package/docs/types/_internal_.BufferLike.html +0 -1
  256. package/docs/types/_internal_.ComposeFnParam.html +0 -1
  257. package/docs/types/_internal_.DefaultEventMap.html +0 -1
  258. package/docs/types/_internal_.EventMap.html +0 -1
  259. package/docs/types/_internal_.InstanceType.html +0 -2
  260. package/docs/types/_internal_.IteratorResult.html +0 -1
  261. package/docs/types/_internal_.Key.html +0 -1
  262. package/docs/types/_internal_.Key2.html +0 -1
  263. package/docs/types/_internal_.KeyFormat.html +0 -1
  264. package/docs/types/_internal_.KeyObjectType.html +0 -1
  265. package/docs/types/_internal_.KeyType-1.html +0 -1
  266. package/docs/types/_internal_.KeyType.html +0 -1
  267. package/docs/types/_internal_.KeyUsage.html +0 -1
  268. package/docs/types/_internal_.Listener.html +0 -1
  269. package/docs/types/_internal_.LookupFunction.html +0 -1
  270. package/docs/types/_internal_.OutgoingHttpHeader.html +0 -1
  271. package/docs/types/_internal_.Partial.html +0 -2
  272. package/docs/types/_internal_.Pick.html +0 -2
  273. package/docs/types/_internal_.PropertyKey.html +0 -1
  274. package/docs/types/_internal_.ReadableStreamController.html +0 -1
  275. package/docs/types/_internal_.ReadableStreamDefaultReadResult.html +0 -1
  276. package/docs/types/_internal_.ReadableStreamReadResult.html +0 -1
  277. package/docs/types/_internal_.Record.html +0 -2
  278. package/docs/types/_internal_.RequestListener.html +0 -1
  279. package/docs/types/_internal_.SecureVersion.html +0 -1
  280. package/docs/types/_internal_.ServerOptions-1.html +0 -1
  281. package/docs/types/_internal_.SocketConnectOpts.html +0 -1
  282. package/docs/types/_internal_.SocketReadyState.html +0 -1
  283. package/docs/types/_internal_.TypedArray.html +0 -1
  284. package/docs/types/_internal_.WebSocket.CertMeta.html +0 -2
  285. package/docs/types/_internal_.WebSocket.Data.html +0 -2
  286. package/docs/types/_internal_.WebSocket.RawData.html +0 -2
  287. package/docs/types/_internal_.WebSocket.VerifyClientCallbackAsync.html +0 -4
  288. package/docs/types/_internal_.WebSocket.VerifyClientCallbackSync.html +0 -4
  289. package/docs/types/_internal_.WithImplicitCoercion.html +0 -1
  290. package/docs/types/_internal_.internal.PipelineCallback.html +0 -1
  291. package/docs/types/_internal_.internal.PipelineDestination.html +0 -1
  292. package/docs/types/_internal_.internal.PipelineDestinationIterableFunction.html +0 -1
  293. package/docs/types/_internal_.internal.PipelineDestinationPromiseFunction.html +0 -1
  294. package/docs/types/_internal_.internal.PipelinePromise.html +0 -1
  295. package/docs/types/_internal_.internal.PipelineSource.html +0 -1
  296. package/docs/types/_internal_.internal.PipelineSourceFunction.html +0 -1
  297. package/docs/types/_internal_.internal.PipelineTransform.html +0 -1
  298. package/docs/types/_internal_.internal.PipelineTransformSource.html +0 -1
  299. package/docs/types/_internal_.internal.TransformCallback.html +0 -1
  300. package/docs/variables/_internal_.Buffer-1.html +0 -1
  301. package/docs/variables/_internal_.Error-1.html +0 -1
  302. package/docs/variables/_internal_.Object-1.html +0 -2
  303. package/docs/variables/_internal_.ReadableByteStreamController-1.html +0 -1
  304. package/docs/variables/_internal_.ReadableStream-2.html +0 -1
  305. package/docs/variables/_internal_.ReadableStreamBYOBReader-1.html +0 -1
  306. package/docs/variables/_internal_.ReadableStreamDefaultController-1.html +0 -1
  307. package/docs/variables/_internal_.ReadableStreamDefaultReader-1.html +0 -1
  308. package/docs/variables/_internal_.SharedArrayBuffer-1.html +0 -1
  309. package/docs/variables/_internal_.WebSocket.WebSocket-1.html +0 -1
  310. package/docs/variables/_internal_.WebSocket.WebSocketServer-1.html +0 -1
  311. package/docs/variables/_internal_.WebSocketAlias-1.html +0 -1
  312. package/docs/variables/_internal_.WritableStream-2.html +0 -1
  313. package/docs/variables/_internal_.WritableStreamDefaultController-1.html +0 -1
  314. package/docs/variables/_internal_.WritableStreamDefaultWriter-1.html +0 -1
  315. package/docs/variables/_internal_.internal.consumers.html +0 -1
  316. package/docs/variables/_internal_.internal.promises.html +0 -1
  317. package/docs/variables/default.html +0 -1
  318. package/script/gen.js +0 -27
  319. package/src/index.ts +0 -107
  320. package/src/modules/agent.ts +0 -120
  321. package/src/modules/agentlib/agent.ts +0 -406
  322. package/src/modules/agentlib/systemprompt.ts +0 -55
  323. package/src/modules/agentlib/taskInstruction.ts +0 -105
  324. package/src/modules/agentlib/usermessage.ts +0 -188
  325. package/src/modules/browser.ts +0 -352
  326. package/src/modules/chat.ts +0 -229
  327. package/src/modules/codeparsers.ts +0 -28
  328. package/src/modules/codeutils.ts +0 -182
  329. package/src/modules/crawler.ts +0 -121
  330. package/src/modules/dbmemory.ts +0 -52
  331. package/src/modules/debug.ts +0 -68
  332. package/src/modules/docutils.ts +0 -18
  333. package/src/modules/fs.ts +0 -263
  334. package/src/modules/git.ts +0 -237
  335. package/src/modules/history.ts +0 -82
  336. package/src/modules/knowledge.ts +0 -5
  337. package/src/modules/llm.ts +0 -36
  338. package/src/modules/outputparsers.ts +0 -30
  339. package/src/modules/project.ts +0 -68
  340. package/src/modules/rag.ts +0 -27
  341. package/src/modules/search.ts +0 -32
  342. package/src/modules/state.ts +0 -115
  343. package/src/modules/task.ts +0 -73
  344. package/src/modules/terminal.ts +0 -113
  345. package/src/modules/tokenizer.ts +0 -56
  346. package/src/modules/toolBox.ts +0 -1384
  347. package/src/modules/tools.ts +0 -254
  348. package/src/modules/vectordb.ts +0 -102
  349. package/src/modules/websocket.ts +0 -97
  350. package/src/utils.ts +0 -5
  351. package/tests/chat.test.js +0 -0
  352. package/tests/fs.test.js +0 -89
  353. package/tests/index.test.js +0 -4
  354. package/tsconfig.json +0 -122
  355. package/utils.d.ts +0 -5
  356. package/webpack.config.js +0 -25
  357. /package/{modules → dist}/agentlib/agent.d.ts +0 -0
  358. /package/{modules → dist}/agentlib/systemprompt.d.ts +0 -0
  359. /package/{modules → dist}/agentlib/systemprompt.js +0 -0
  360. /package/{modules → dist}/agentlib/taskInstruction.d.ts +0 -0
  361. /package/{modules → dist}/agentlib/taskInstruction.js +0 -0
  362. /package/{modules → dist}/agentlib/usermessage.d.ts +0 -0
  363. /package/{modules → dist/modules}/agent.d.ts +0 -0
  364. /package/{modules → dist/modules}/agent.js +0 -0
  365. /package/{modules → dist/modules}/browser.d.ts +0 -0
  366. /package/{modules → dist/modules}/browser.js +0 -0
  367. /package/{modules → dist/modules}/chat.d.ts +0 -0
  368. /package/{modules → dist/modules}/chat.js +0 -0
  369. /package/{modules → dist/modules}/codeparsers.d.ts +0 -0
  370. /package/{modules → dist/modules}/codeparsers.js +0 -0
  371. /package/{modules → dist/modules}/codeutils.d.ts +0 -0
  372. /package/{modules → dist/modules}/codeutils.js +0 -0
  373. /package/{modules → dist/modules}/crawler.d.ts +0 -0
  374. /package/{modules → dist/modules}/crawler.js +0 -0
  375. /package/{modules → dist/modules}/dbmemory.d.ts +0 -0
  376. /package/{modules → dist/modules}/dbmemory.js +0 -0
  377. /package/{modules → dist/modules}/debug.d.ts +0 -0
  378. /package/{modules → dist/modules}/debug.js +0 -0
  379. /package/{modules → dist/modules}/docutils.d.ts +0 -0
  380. /package/{modules → dist/modules}/docutils.js +0 -0
  381. /package/{modules → dist/modules}/fs.d.ts +0 -0
  382. /package/{modules → dist/modules}/fs.js +0 -0
  383. /package/{modules → dist/modules}/git.d.ts +0 -0
  384. /package/{modules → dist/modules}/git.js +0 -0
  385. /package/{modules → dist/modules}/history.d.ts +0 -0
  386. /package/{modules → dist/modules}/history.js +0 -0
  387. /package/{modules → dist/modules}/knowledge.d.ts +0 -0
  388. /package/{modules → dist/modules}/knowledge.js +0 -0
  389. /package/{modules → dist/modules}/llm.d.ts +0 -0
  390. /package/{modules → dist/modules}/llm.js +0 -0
  391. /package/{modules → dist/modules}/outputparsers.d.ts +0 -0
  392. /package/{modules → dist/modules}/outputparsers.js +0 -0
  393. /package/{modules → dist/modules}/project.d.ts +0 -0
  394. /package/{modules → dist/modules}/project.js +0 -0
  395. /package/{modules → dist/modules}/rag.d.ts +0 -0
  396. /package/{modules → dist/modules}/rag.js +0 -0
  397. /package/{modules → dist/modules}/search.d.ts +0 -0
  398. /package/{modules → dist/modules}/search.js +0 -0
  399. /package/{modules → dist/modules}/state.d.ts +0 -0
  400. /package/{modules → dist/modules}/state.js +0 -0
  401. /package/{modules → dist/modules}/task.d.ts +0 -0
  402. /package/{modules → dist/modules}/task.js +0 -0
  403. /package/{modules → dist/modules}/terminal.d.ts +0 -0
  404. /package/{modules → dist/modules}/terminal.js +0 -0
  405. /package/{modules → dist/modules}/tokenizer.d.ts +0 -0
  406. /package/{modules → dist/modules}/tokenizer.js +0 -0
  407. /package/{modules → dist/modules}/toolBox.d.ts +0 -0
  408. /package/{modules → dist/modules}/toolBox.js +0 -0
  409. /package/{modules → dist/modules}/tools.d.ts +0 -0
  410. /package/{modules → dist/modules}/tools.js +0 -0
  411. /package/{modules → dist/modules}/vectordb.d.ts +0 -0
  412. /package/{modules → dist/modules}/vectordb.js +0 -0
  413. /package/{modules → dist/modules}/websocket.d.ts +0 -0
  414. /package/{modules → dist/modules}/websocket.js +0 -0
package/docs/classes/_internal_.Codebolt.html DELETED
@@ -1,315 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Codebolt | @codebolt/codeboltjs</title><meta name="description" content="Documentation for @codebolt/codeboltjs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@codebolt/codeboltjs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@codebolt/codeboltjs</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.Codebolt.html">Codebolt</a></li></ul><h1>Class Codebolt</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Codebolt</p>
2
- </div><div class="tsd-comment tsd-typography"><h4>Description</h4><p>This class provides a unified interface to interact with various modules.</p>
3
- </div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L32">src/index.ts:32</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_internal_.Codebolt.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
4
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_internal_.Codebolt.html#browser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>browser</span></a>
5
- <a href="_internal_.Codebolt.html#cbstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cbstate</span></a>
6
- <a href="_internal_.Codebolt.html#chat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chat</span></a>
7
- <a href="_internal_.Codebolt.html#chatSummary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chat<wbr/>Summary</span></a>
8
- <a href="_internal_.Codebolt.html#codeparsers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>codeparsers</span></a>
9
- <a href="_internal_.Codebolt.html#codeutils" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>codeutils</span></a>
10
- <a href="_internal_.Codebolt.html#crawler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crawler</span></a>
11
- <a href="_internal_.Codebolt.html#dbmemory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dbmemory</span></a>
12
- <a href="_internal_.Codebolt.html#debug" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a>
13
- <a href="_internal_.Codebolt.html#docutils" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docutils</span></a>
14
- <a href="_internal_.Codebolt.html#fs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fs</span></a>
15
- <a href="_internal_.Codebolt.html#git" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git</span></a>
16
- <a href="_internal_.Codebolt.html#knowledge" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>knowledge</span></a>
17
- <a href="_internal_.Codebolt.html#llm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>llm</span></a>
18
- <a href="_internal_.Codebolt.html#outputparsers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outputparsers</span></a>
19
- <a href="_internal_.Codebolt.html#project" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project</span></a>
20
- <a href="_internal_.Codebolt.html#rag" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rag</span></a>
21
- <a href="_internal_.Codebolt.html#search-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search</span></a>
22
- <a href="_internal_.Codebolt.html#taskplaner" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>taskplaner</span></a>
23
- <a href="_internal_.Codebolt.html#terminal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terminal</span></a>
24
- <a href="_internal_.Codebolt.html#tokenizer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokenizer</span></a>
25
- <a href="_internal_.Codebolt.html#vectordb" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vectordb</span></a>
26
- <a href="_internal_.Codebolt.html#websocket" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>websocket</span></a>
27
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_internal_.Codebolt.html#waitForConnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>For<wbr/>Connection</span></a>
28
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Codebolt" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Codebolt</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Codebolt.html" class="tsd-signature-type tsd-kind-class">Codebolt</a><a href="#constructor.new_Codebolt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_internal_.Codebolt.html" class="tsd-signature-type tsd-kind-class">Codebolt</a></h4><div class="tsd-comment tsd-typography"><h4>Description</h4><p>Initializes the websocket connection.</p>
29
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L38">src/index.ts:38</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="browser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>browser</span><a href="#browser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">browser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">click</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">close</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">enter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">extractText</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ExtractTextResponse.html" class="tsd-signature-type tsd-kind-interface">ExtractTextResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getBrowserInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getContent</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetContentResponse.html" class="tsd-signature-type tsd-kind-interface">GetContentResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getHTML</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.HtmlReceived.html" class="tsd-signature-type tsd-kind-interface">HtmlReceived</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getMarkdown</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMarkdownResponse.html" class="tsd-signature-type tsd-kind-interface">GetMarkdownResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getPDF</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getSnapShot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getUrl</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UrlResponse.html" class="tsd-signature-type tsd-kind-interface">UrlResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">goToPage</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GoToPageResponse.html" class="tsd-signature-type tsd-kind-interface">GoToPageResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">newPage</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pdfToText</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">screenshot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">scroll</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span>, <span class="tsd-kind-parameter">pixels</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbbrowser</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">click</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Clicks on a specified element on the page.</p>
30
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the click action is complete.</p>
31
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.click.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">elementid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the element to click.</p>
32
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">close</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Closes the current page.</p>
33
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.close.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">enter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Simulates the Enter key press on the current page.</p>
34
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the Enter action is complete.</p>
35
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.enter.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">extract<wbr/>Text</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ExtractTextResponse.html" class="tsd-signature-type tsd-kind-interface">ExtractTextResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Extracts text from the current page.</p>
36
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the extracted text.</p>
37
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.extractText.__type-7.__type-8"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ExtractTextResponse.html" class="tsd-signature-type tsd-kind-interface">ExtractTextResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ExtractTextResponse.html" class="tsd-signature-type tsd-kind-interface">ExtractTextResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Browser<wbr/>Info</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves browser info like height width scrollx scrolly of the current page.</p>
38
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the content.</p>
39
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getBrowserInfo.__type-9.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetContentResponse.html" class="tsd-signature-type tsd-kind-interface">GetContentResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the content of the current page.</p>
40
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the content.</p>
41
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getContent.__type-11.__type-12"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetContentResponse.html" class="tsd-signature-type tsd-kind-interface">GetContentResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetContentResponse.html" class="tsd-signature-type tsd-kind-interface">GetContentResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">getHTML</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.HtmlReceived.html" class="tsd-signature-type tsd-kind-interface">HtmlReceived</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the HTML content of the current page.</p>
42
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the HTML content.</p>
43
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getHTML.__type-13.__type-14"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.HtmlReceived.html" class="tsd-signature-type tsd-kind-interface">HtmlReceived</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.HtmlReceived.html" class="tsd-signature-type tsd-kind-interface">HtmlReceived</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Markdown</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMarkdownResponse.html" class="tsd-signature-type tsd-kind-interface">GetMarkdownResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the Markdown content of the current page.</p>
44
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the Markdown content.</p>
45
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getMarkdown.__type-15.__type-16"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMarkdownResponse.html" class="tsd-signature-type tsd-kind-interface">GetMarkdownResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMarkdownResponse.html" class="tsd-signature-type tsd-kind-interface">GetMarkdownResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">getPDF</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the PDF content of the current page.</p>
46
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getPDF.__type-17.__type-18"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Snap<wbr/>Shot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the snapshot of the current page.</p>
47
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the content.</p>
48
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getSnapShot.__type-19.__type-20"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Url</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UrlResponse.html" class="tsd-signature-type tsd-kind-interface">UrlResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the current URL of the browser&#39;s active page.</p>
49
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the URL.</p>
50
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.getUrl.__type-21.__type-22"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UrlResponse.html" class="tsd-signature-type tsd-kind-interface">UrlResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UrlResponse.html" class="tsd-signature-type tsd-kind-interface">UrlResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">go<wbr/>To<wbr/>Page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GoToPageResponse.html" class="tsd-signature-type tsd-kind-interface">GoToPageResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Navigates to a specified URL.</p>
51
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when navigation is complete.</p>
52
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.goToPage.__type-23.__type-24"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GoToPageResponse.html" class="tsd-signature-type tsd-kind-interface">GoToPageResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The URL to navigate to.</p>
53
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GoToPageResponse.html" class="tsd-signature-type tsd-kind-interface">GoToPageResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">new<wbr/>Page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Opens a new page in the browser.</p>
54
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.newPage.__type-25.__type-26"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pdf<wbr/>To<wbr/>Text</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Converts the PDF content of the current page to text.</p>
55
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.pdfToText.__type-27.__type-28"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">screenshot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Takes a screenshot of the current page.</p>
56
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.screenshot.__type-29.__type-30"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">scroll</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span>, <span class="tsd-kind-parameter">pixels</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Scrolls the current page in a specified direction by a specified number of pixels.</p>
57
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the scroll action is complete.</p>
58
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.scroll.__type-31.__type-32"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span>, <span class="tsd-kind-parameter">pixels</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">direction</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The direction to scroll.</p>
59
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">pixels</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The number of pixels to scroll.</p>
60
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Performs a search on the current page using a specified query.</p>
61
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the search results.</p>
62
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.search.__type-33.__type-34"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">elementid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the element to perform the search in.</p>
63
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The search query.</p>
64
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Types text into a specified element on the page.</p>
65
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the typing action is complete.</p>
66
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="browser.__type.type.__type-35.__type-36"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">elementid</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">elementid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the element to type into.</p>
67
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The text to type.</p>
68
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L75">src/index.ts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="cbstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cbstate</span><a href="#cbstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cbstate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">addToAgentState</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddToAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">AddToAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getAgentState</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">GetAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getApplicationState</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ApplicationState.html" class="tsd-signature-type tsd-kind-interface">ApplicationState</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbstate</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add<wbr/>To<wbr/>Agent<wbr/>State</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddToAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">AddToAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a key-value pair to the agent&#39;s state on the server via WebSocket.</p>
69
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response to the addition request.</p>
70
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="cbstate.__type-37.addToAgentState.__type-38.__type-39"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddToAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">AddToAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key to add to the agent&#39;s state.</p>
71
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The value associated with the key.</p>
72
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddToAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">AddToAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Agent<wbr/>State</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">GetAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the current state of the agent from the server via WebSocket.</p>
73
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the agent&#39;s state.</p>
74
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="cbstate.__type-37.getAgentState.__type-40.__type-41"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">GetAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetAgentStateResponse.html" class="tsd-signature-type tsd-kind-interface">GetAgentStateResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Application<wbr/>State</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ApplicationState.html" class="tsd-signature-type tsd-kind-interface">ApplicationState</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the current application state from the server via WebSocket.</p>
75
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the application state.</p>
76
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="cbstate.__type-37.getApplicationState.__type-42.__type-43"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ApplicationState.html" class="tsd-signature-type tsd-kind-interface">ApplicationState</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ApplicationState.html" class="tsd-signature-type tsd-kind-interface">ApplicationState</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L88">src/index.ts:88</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="chat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>chat</span><a href="#chat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">chat</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getChatHistory</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ChatMessage.html" class="tsd-signature-type tsd-kind-interface">ChatMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">onActionMessage</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">processFinished</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">processStarted</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">stopProcess</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sendConfirmationRequest</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">confirmationMessage</span>, <span class="tsd-kind-parameter">buttons</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">withFeedback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sendMessage</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sendNotificationEvent</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">notificationMessage</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">stopProcess</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">waitforReply</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UserMessage.html" class="tsd-signature-type tsd-kind-interface">UserMessage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbchat</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Chat<wbr/>History</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ChatMessage.html" class="tsd-signature-type tsd-kind-interface">ChatMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the chat history from the server.</p>
77
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with an array of ChatMessage objects representing the chat history.</p>
78
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.getChatHistory.__type-45.__type-46"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ChatMessage.html" class="tsd-signature-type tsd-kind-interface">ChatMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ChatMessage.html" class="tsd-signature-type tsd-kind-interface">ChatMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">on<wbr/>Action<wbr/>Message</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sets up a listener for incoming WebSocket messages and emits a custom event when a message is received.</p>
79
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>The event emitter used for emitting custom events.</p>
80
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.onActionMessage.__type-47.__type-48"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">process<wbr/>Finished</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Stops the ongoing process.
81
- Sends a specific message to the server to stop the process.</p>
82
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.processFinished.__type-49.__type-50"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">process<wbr/>Started</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">stopProcess</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Notifies the server that a process has started and sets up an event listener for stopProcessClicked events.</p>
83
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>An object containing the event emitter and a stopProcess method.</p>
84
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.processStarted.__type-51.__type-52"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">stopProcess</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">stopProcess</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">stop<wbr/>Process</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.processStarted.__type-51.__type-52.__type-53.stopProcess.__type-54.__type-55"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">send<wbr/>Confirmation<wbr/>Request</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">confirmationMessage</span>, <span class="tsd-kind-parameter">buttons</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">withFeedback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sends a confirmation request to the server with two options: Yes or No.</p>
85
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the server&#39;s response.</p>
86
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.sendConfirmationRequest.__type-56.__type-57"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">confirmationMessage</span>, <span class="tsd-kind-parameter">buttons</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">withFeedback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">confirmationMessage</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">buttons</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li><li><span><span class="tsd-kind-parameter">withFeedback</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">send<wbr/>Message</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sends a message through the WebSocket connection.</p>
87
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.sendMessage.__type-58.__type-59"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">payload</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message to be sent.</p>
88
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">payload</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">send<wbr/>Notification<wbr/>Event</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">notificationMessage</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sends a notification event to the server.</p>
89
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.sendNotificationEvent.__type-60.__type-61"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">notificationMessage</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">notificationMessage</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message to be sent in the notification.</p>
90
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">&quot;debug&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;git&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;planner&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;browser&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;editor&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;terminal&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;preview&quot;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">stop<wbr/>Process</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Stops the ongoing process.
91
- Sends a specific message to the server to stop the process.</p>
92
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.stopProcess-1.__type-62.__type-63"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">waitfor<wbr/>Reply</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UserMessage.html" class="tsd-signature-type tsd-kind-interface">UserMessage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Waits for a reply to a sent message.</p>
93
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the reply.</p>
94
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chat.__type-44.waitforReply.__type-64.__type-65"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UserMessage.html" class="tsd-signature-type tsd-kind-interface">UserMessage</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message for which a reply is expected.</p>
95
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UserMessage.html" class="tsd-signature-type tsd-kind-interface">UserMessage</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L76">src/index.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="chatSummary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>chat<wbr/>Summary</span><a href="#chatSummary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">chat<wbr/>Summary</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">summarize</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">messages</span>, <span class="tsd-kind-parameter">depth</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">summarizeAll</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = chatSummary</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">summarize</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">messages</span>, <span class="tsd-kind-parameter">depth</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chatSummary.__type-66.summarize.__type-67.__type-68"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">messages</span>, <span class="tsd-kind-parameter">depth</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">messages</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">depth</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">summarize<wbr/>All</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="chatSummary.__type-66.summarizeAll.__type-69.__type-70"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L93">src/index.ts:93</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="codeparsers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>codeparsers</span><a href="#codeparsers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">codeparsers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getAstTreeInFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getClassesInFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getFunctionsinClass</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbcodeparsers</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Ast<wbr/>Tree<wbr/>In<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Generates an Abstract Syntax Tree (AST) for a given file.</p>
96
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeparsers.__type-71.getAstTreeInFile.__type-72.__type-73"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The file to generate an AST for.</p>
97
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">className</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The name of the class to focus the AST generation on.</p>
98
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Classes<wbr/>In<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the classes in a given file.</p>
99
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeparsers.__type-71.getClassesInFile.__type-74.__type-75"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The file to parse for classes.</p>
100
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Functionsin<wbr/>Class</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the functions in a given class within a file.</p>
101
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeparsers.__type-71.getFunctionsinClass.__type-76.__type-77"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span>, <span class="tsd-kind-parameter">className</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">file</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The file containing the class.</p>
102
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">className</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The name of the class to parse for functions.</p>
103
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L84">src/index.ts:84</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="codeutils" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>codeutils</span><a href="#codeutils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">codeutils</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getAllFilesAsMarkDown</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getJsTree</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getMatcherList</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMatcherListTreeResponse.html" class="tsd-signature-type tsd-kind-interface">GetMatcherListTreeResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">matchDetail</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.getMatchDetail.html" class="tsd-signature-type tsd-kind-interface">getMatchDetail</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">performMatch</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcherDefinition</span>, <span class="tsd-kind-parameter">problemPatterns</span>, <span class="tsd-kind-parameter">problems</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MatchProblemResponse.html" class="tsd-signature-type tsd-kind-interface">MatchProblemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbcodeutils</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>All<wbr/>Files<wbr/>As<wbr/>Mark<wbr/>Down</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves all files as Markdown.</p>
104
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the Markdown content of all files.</p>
105
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeutils.__type-78.getAllFilesAsMarkDown.__type-79.__type-80"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Js<wbr/>Tree</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves a JavaScript tree structure for a given file path.</p>
106
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the JS tree response.</p>
107
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeutils.__type-78.getJsTree.__type-81.__type-82"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to retrieve the JS tree for.</p>
108
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Matcher<wbr/>List</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMatcherListTreeResponse.html" class="tsd-signature-type tsd-kind-interface">GetMatcherListTreeResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the list of matchers.</p>
109
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the list of matchers response.</p>
110
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeutils.__type-78.getMatcherList.__type-83.__type-84"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMatcherListTreeResponse.html" class="tsd-signature-type tsd-kind-interface">GetMatcherListTreeResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetMatcherListTreeResponse.html" class="tsd-signature-type tsd-kind-interface">GetMatcherListTreeResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">match<wbr/>Detail</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.getMatchDetail.html" class="tsd-signature-type tsd-kind-interface">getMatchDetail</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves details of a match.</p>
111
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the match detail response.</p>
112
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeutils.__type-78.matchDetail.__type-85.__type-86"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.getMatchDetail.html" class="tsd-signature-type tsd-kind-interface">getMatchDetail</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">matcher</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The matcher to retrieve details for.</p>
113
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.getMatchDetail.html" class="tsd-signature-type tsd-kind-interface">getMatchDetail</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">perform<wbr/>Match</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcherDefinition</span>, <span class="tsd-kind-parameter">problemPatterns</span>, <span class="tsd-kind-parameter">problems</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MatchProblemResponse.html" class="tsd-signature-type tsd-kind-interface">MatchProblemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Performs a matching operation based on the provided matcher definition and problem patterns.</p>
114
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the matching problem response.</p>
115
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="codeutils.__type-78.performMatch.__type-87.__type-88"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">matcherDefinition</span>, <span class="tsd-kind-parameter">problemPatterns</span>, <span class="tsd-kind-parameter">problems</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MatchProblemResponse.html" class="tsd-signature-type tsd-kind-interface">MatchProblemResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">matcherDefinition</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The definition of the matcher.</p>
116
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">problemPatterns</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The patterns to match against.</p>
117
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">problems</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of problems.</p>
118
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MatchProblemResponse.html" class="tsd-signature-type tsd-kind-interface">MatchProblemResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L78">src/index.ts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="crawler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>crawler</span><a href="#crawler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">crawler</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">click</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">crawl</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">enter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">goToPage</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">screenshot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">scroll</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbcrawler</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">click</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Simulates a click event on an element with the specified ID.</p>
119
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the click action is complete.</p>
120
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.click-1.__type-90.__type-91"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the element to be clicked.</p>
121
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">crawl</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Initiates a crawl process.</p>
122
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.crawl.__type-92.__type-93"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">enter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Simulates the Enter key press using the crawler.</p>
123
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.enter-1.__type-94.__type-95"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">go<wbr/>To<wbr/>Page</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Directs the crawler to navigate to a specified URL.</p>
124
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.goToPage-1.__type-96.__type-97"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The URL for the crawler to navigate to.</p>
125
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">screenshot</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Takes a screenshot using the crawler.</p>
126
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.screenshot-1.__type-98.__type-99"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">scroll</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Scrolls the crawler in a specified direction.</p>
127
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.scroll-1.__type-100.__type-101"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">direction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">direction</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The direction to scroll (&#39;up&#39;, &#39;down&#39;, &#39;left&#39;, &#39;right&#39;).</p>
128
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Starts the crawler.</p>
129
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.start.__type-102.__type-103"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Types the provided text into an element with the specified ID.</p>
130
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the type action is complete.</p>
131
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="crawler.__type-89.type-1.__type-104.__type-105"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the element where text will be typed.</p>
132
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The text to type into the element.</p>
133
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L80">src/index.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dbmemory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dbmemory</span><a href="#dbmemory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dbmemory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">addKnowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemorySetResponse.html" class="tsd-signature-type tsd-kind-interface">MemorySetResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getKnowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemoryGetResponse.html" class="tsd-signature-type tsd-kind-interface">MemoryGetResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = dbmemory</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add<wbr/>Knowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemorySetResponse.html" class="tsd-signature-type tsd-kind-interface">MemorySetResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a key-value pair to the in-memory database.</p>
134
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the memory set event.</p>
135
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="dbmemory.__type-106.addKnowledge.__type-107.__type-108"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemorySetResponse.html" class="tsd-signature-type tsd-kind-interface">MemorySetResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key under which to store the value.</p>
136
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The value to be stored.</p>
137
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemorySetResponse.html" class="tsd-signature-type tsd-kind-interface">MemorySetResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Knowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemoryGetResponse.html" class="tsd-signature-type tsd-kind-interface">MemoryGetResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves a value from the in-memory database by key.</p>
138
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the memory get event.</p>
139
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="dbmemory.__type-106.getKnowledge.__type-109.__type-110"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemoryGetResponse.html" class="tsd-signature-type tsd-kind-interface">MemoryGetResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key of the value to retrieve.</p>
140
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.MemoryGetResponse.html" class="tsd-signature-type tsd-kind-interface">MemoryGetResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L87">src/index.ts:87</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">log</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DebugAddLogResponse.html" class="tsd-signature-type tsd-kind-interface">DebugAddLogResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">openDebugBrowser</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">port</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.OpenDebugBrowserResponse.html" class="tsd-signature-type tsd-kind-interface">OpenDebugBrowserResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = debug</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">log</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DebugAddLogResponse.html" class="tsd-signature-type tsd-kind-interface">DebugAddLogResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sends a log message to the debug websocket and waits for a response.</p>
141
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the debug event.</p>
142
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="debug.__type-111.debug-1.__type-112.__type-113"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">log</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DebugAddLogResponse.html" class="tsd-signature-type tsd-kind-interface">DebugAddLogResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">log</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The log message to send.</p>
143
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">type</span>: <a href="../enums/_internal_.logType.html" class="tsd-signature-type tsd-kind-enum">logType</a></span><div class="tsd-comment tsd-typography"><p>The type of the log message (info, error, warning).</p>
144
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DebugAddLogResponse.html" class="tsd-signature-type tsd-kind-interface">DebugAddLogResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">open<wbr/>Debug<wbr/>Browser</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">port</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.OpenDebugBrowserResponse.html" class="tsd-signature-type tsd-kind-interface">OpenDebugBrowserResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Requests to open a debug browser at the specified URL and port.</p>
145
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the open debug browser event.</p>
146
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="debug.__type-111.openDebugBrowser.__type-114.__type-115"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">port</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.OpenDebugBrowserResponse.html" class="tsd-signature-type tsd-kind-interface">OpenDebugBrowserResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The URL where the debug browser should be opened.</p>
147
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">port</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The port on which the debug browser will listen.</p>
148
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.OpenDebugBrowserResponse.html" class="tsd-signature-type tsd-kind-interface">OpenDebugBrowserResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L91">src/index.ts:91</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="docutils" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>docutils</span><a href="#docutils" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">docutils</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">pdf_to_text</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pdf_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbdocutils</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">pdf_<wbr/>to_<wbr/>text</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pdf_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Converts a PDF document to text.</p>
149
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the converted text.</p>
150
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="docutils.__type-116.pdf_to_text.__type-117.__type-118"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pdf_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pdf_path</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The file path to the PDF document to be converted.</p>
151
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L79">src/index.ts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fs</span><a href="#fs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">createFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fileName</span>, <span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFileResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">createFolder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderName</span>, <span class="tsd-kind-parameter">folderPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFolderResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFolderResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">deleteFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFileResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">deleteFolder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">foldername</span>, <span class="tsd-kind-parameter">folderpath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFolderResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFolderResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">listCodeDefinitionNames</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">listFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderPath</span>, <span class="tsd-kind-parameter">isRecursive</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">readFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ReadFileResponse.html" class="tsd-signature-type tsd-kind-interface">ReadFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">searchFiles</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">regex</span>, <span class="tsd-kind-parameter">filePattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">updateFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UpdateFileResponse.html" class="tsd-signature-type tsd-kind-interface">UpdateFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">writeToFile</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">relPath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbfs</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">create<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fileName</span>, <span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFileResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>createFile</p>
152
- <h4>Description</h4><p>Creates a new file.</p>
153
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
154
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.createFile.__type-120.__type-121"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fileName</span>, <span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFileResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFileResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fileName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the file to create.</p>
155
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The source content to write into the file.</p>
156
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path where the file should be created.</p>
157
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFileResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFileResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">create<wbr/>Folder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderName</span>, <span class="tsd-kind-parameter">folderPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFolderResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFolderResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>createFolder</p>
158
- <h4>Description</h4><p>Creates a new folder.</p>
159
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
160
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.createFolder.__type-122.__type-123"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderName</span>, <span class="tsd-kind-parameter">folderPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFolderResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFolderResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">folderName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the folder to create.</p>
161
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">folderPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path where the folder should be created.</p>
162
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CreateFolderResponse.html" class="tsd-signature-type tsd-kind-interface">CreateFolderResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">delete<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFileResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>deleteFile</p>
163
- <h4>Description</h4><p>Deletes a file.</p>
164
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
165
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.deleteFile.__type-124.__type-125"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFileResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFileResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the file to delete.</p>
166
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to delete.</p>
167
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFileResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFileResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">delete<wbr/>Folder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">foldername</span>, <span class="tsd-kind-parameter">folderpath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFolderResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFolderResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>deleteFolder</p>
168
- <h4>Description</h4><p>Deletes a folder.</p>
169
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
170
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.deleteFolder.__type-126.__type-127"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">foldername</span>, <span class="tsd-kind-parameter">folderpath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFolderResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFolderResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">foldername</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the folder to delete.</p>
171
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">folderpath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the folder to delete.</p>
172
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.DeleteFolderResponse.html" class="tsd-signature-type tsd-kind-interface">DeleteFolderResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">list<wbr/>Code<wbr/>Definition<wbr/>Names</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>listCodeDefinitionNames</p>
173
- <h4>Description</h4><p>Lists all code definition names in a given path.</p>
174
- <h4>Returns</h4><p>A promise that resolves with the list of code definition names.</p>
175
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.listCodeDefinitionNames.__type-128.__type-129"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to search for code definitions.</p>
176
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">list<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderPath</span>, <span class="tsd-kind-parameter">isRecursive</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>listFile</p>
177
- <h4>Description</h4><p>Lists all files.</p>
178
- <h4>Returns</h4><p>A promise that resolves with the list of files.</p>
179
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.listFile.__type-130.__type-131"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">folderPath</span>, <span class="tsd-kind-parameter">isRecursive</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">folderPath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">isRecursive</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">read<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ReadFileResponse.html" class="tsd-signature-type tsd-kind-interface">ReadFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>readFile</p>
180
- <h4>Description</h4><p>Reads the content of a file.</p>
181
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
182
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.readFile.__type-132.__type-133"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ReadFileResponse.html" class="tsd-signature-type tsd-kind-interface">ReadFileResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to read.</p>
183
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.ReadFileResponse.html" class="tsd-signature-type tsd-kind-interface">ReadFileResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">search<wbr/>Files</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">regex</span>, <span class="tsd-kind-parameter">filePattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>searchFiles</p>
184
- <h4>Description</h4><p>Searches files in a given path using a regex pattern.</p>
185
- <h4>Returns</h4><p>A promise that resolves with the search results.</p>
186
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.searchFiles.__type-134.__type-135"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">regex</span>, <span class="tsd-kind-parameter">filePattern</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to search within.</p>
187
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">regex</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The regex pattern to search for.</p>
188
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filePattern</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file pattern to match files.</p>
189
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">result</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">update<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UpdateFileResponse.html" class="tsd-signature-type tsd-kind-interface">UpdateFileResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>updateFile</p>
190
- <h4>Description</h4><p>Updates the content of a file.</p>
191
- <h4>Returns</h4><p>A promise that resolves with the server response.</p>
192
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.updateFile.__type-136.__type-137"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UpdateFileResponse.html" class="tsd-signature-type tsd-kind-interface">UpdateFileResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the file to update.</p>
193
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path of the file to update.</p>
194
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">newContent</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new content to write into the file.</p>
195
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.UpdateFileResponse.html" class="tsd-signature-type tsd-kind-interface">UpdateFileResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">write<wbr/>To<wbr/>File</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">relPath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><h4>Function</h4><p>writeToFile</p>
196
- <h4>Description</h4><p>Writes content to a file.</p>
197
- <h4>Returns</h4><p>A promise that resolves with the write operation result.</p>
198
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="fs.__type-119.writeToFile.__type-138.__type-139"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">relPath</span>, <span class="tsd-kind-parameter">newContent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">relPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The relative path of the file to write to.</p>
199
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">newContent</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new content to write into the file.</p>
200
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L72">src/index.ts:72</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="git" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>git</span><a href="#git" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">git</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">add</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">branch</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">checkout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">clone</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">commit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">diff</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commitHash</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">logs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pull</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">push</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = git</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds changes in the local repository to the staging area at the given path.</p>
201
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the add event.</p>
202
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.add.__type-141.__type-142"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
203
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">branch</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Creates a new branch in the local repository at the given path.</p>
204
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the branch event.</p>
205
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.branch.__type-143.__type-144"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
206
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">branch</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the new branch to create.</p>
207
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">checkout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Checks out a branch or commit in the local repository at the given path.</p>
208
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the checkout event.</p>
209
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.checkout.__type-145.__type-146"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">branch</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
210
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">branch</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the branch or commit to check out.</p>
211
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">clone</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Clones a Git repository from the given URL to the specified path.</p>
212
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the clone event.</p>
213
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.clone.__type-147.__type-148"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The URL of the Git repository to clone.</p>
214
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path where the repository should be cloned to.</p>
215
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">commit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Commits the staged changes in the local repository with the given commit message.</p>
216
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the commit event.</p>
217
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.commit.__type-149.__type-150"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The commit message to use for the commit.</p>
218
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">diff</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commitHash</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the diff of changes for a specific commit in the local repository.</p>
219
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the diff event.</p>
220
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.diff.__type-151.__type-152"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">commitHash</span>, <span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">commitHash</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The hash of the commit to retrieve the diff for.</p>
221
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
222
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Initializes a new Git repository at the given path.</p>
223
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the init event.</p>
224
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.init.__type-153.__type-154"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path where the Git repository should be initialized.</p>
225
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">logs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the commit logs for the local repository at the given path.</p>
226
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the logs event.</p>
227
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.logs.__type-155.__type-156"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
228
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">pull</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Pulls the latest changes from the remote repository to the local repository at the given path.</p>
229
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the pull event.</p>
230
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.pull.__type-157.__type-158"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
231
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">push</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Pushes local repository changes to the remote repository at the given path.</p>
232
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the push event.</p>
233
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.push.__type-159.__type-160"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
234
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the status of the local repository at the given path.</p>
235
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the status event.</p>
236
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="git.__type-140.status.__type-161.__type-162"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file system path of the local Git repository.</p>
237
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L73">src/index.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="knowledge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>knowledge</span><a href="#knowledge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">knowledge</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = cbknowledge</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L82">src/index.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="llm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>llm</span><a href="#llm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">llm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">inference</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">llmrole</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.LLMResponse.html" class="tsd-signature-type tsd-kind-interface">LLMResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbllm</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">inference</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">llmrole</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.LLMResponse.html" class="tsd-signature-type tsd-kind-interface">LLMResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Sends an inference request to the LLM and returns the model&#39;s response.
238
- The model is selected based on the provided <code>llmrole</code>. If the specific model
239
- for the role is not found, it falls back to the default model for the current agent,
240
- and ultimately to the default application-wide LLM if necessary.</p>
241
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the LLM&#39;s response.</p>
242
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="llm.__type-164.inference.__type-165.__type-166"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">llmrole</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.LLMResponse.html" class="tsd-signature-type tsd-kind-interface">LLMResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The input message or prompt to be sent to the LLM.</p>
243
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">llmrole</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The role of the LLM to determine which model to use.</p>
244
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.LLMResponse.html" class="tsd-signature-type tsd-kind-interface">LLMResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L74">src/index.ts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outputparsers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>outputparsers</span><a href="#outputparsers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outputparsers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">parseErrors</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">parseWarnings</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cboutputparsers</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Initializes the output parser module.
245
- Currently, this function does not perform any operations.</p>
246
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="outputparsers.__type-167.init-1.__type-168.__type-169"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">output</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The output to be initialized.</p>
247
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">parse<wbr/>Errors</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Parses the given output and returns all the error messages.</p>
248
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>An array of error messages.</p>
249
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="outputparsers.__type-167.parseErrors.__type-170.__type-171"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">output</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The output to parse for error messages.</p>
250
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">parse<wbr/>Warnings</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Parses the given output and returns all the warning messages.</p>
251
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>An array of warning messages.</p>
252
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="outputparsers.__type-167.parseWarnings.__type-172.__type-173"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">output</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The output to parse for warning messages.</p>
253
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L85">src/index.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="project" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>project</span><a href="#project" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">getProjectPath</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getProjectSettings</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getRepoMap</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">runProject</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbproject</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Project<wbr/>Path</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the path of the current project.</p>
254
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the project path response.</p>
255
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project.__type-174.getProjectPath.__type-175.__type-176"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Project<wbr/>Settings</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Placeholder for a method to get project settings.
256
- Currently, this method does not perform any operations.</p>
257
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project.__type-174.getProjectSettings.__type-177.__type-178"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">output</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">output</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The output where project settings would be stored.</p>
258
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Repo<wbr/>Map</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project.__type-174.getRepoMap.__type-179.__type-180"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetProjectPathResponse.html" class="tsd-signature-type tsd-kind-interface">GetProjectPathResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">run<wbr/>Project</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project.__type-174.runProject.__type-181.__type-182"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L86">src/index.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rag</span><a href="#rag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rag</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">add_file</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">file_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">retrieve_related_knowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">filename</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbrag</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add_<wbr/>file</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">file_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a file to the CodeBolt File System.</p>
259
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="rag.__type-183.add_file.__type-184.__type-185"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span>, <span class="tsd-kind-parameter">file_path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the file to add.</p>
260
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">file_path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path where the file should be added.</p>
261
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Initializes the CodeBolt File System Module.</p>
262
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="rag.__type-183.init-2.__type-186.__type-187"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">retrieve_<wbr/>related_<wbr/>knowledge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">filename</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves related knowledge for a given query and filename.</p>
263
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="rag.__type-183.retrieve_related_knowledge.__type-188.__type-189"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span>, <span class="tsd-kind-parameter">filename</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The query to retrieve related knowledge for.</p>
264
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the file associated with the query.</p>
265
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L83">src/index.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="search-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>search</span><a href="#search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">get_first_link</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">engine</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbsearch</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">get_<wbr/>first_<wbr/>link</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves the first link from the search results for the given query.</p>
266
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the first link of the search results.</p>
267
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="search-1.__type-190.get_first_link.__type-191.__type-192"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The search query.</p>
268
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">init</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">engine</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Initializes the search module with the specified search engine.</p>
269
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="search-1.__type-190.init-3.__type-193.__type-194"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">engine</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">engine</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;bing&quot;</span></span><div class="tsd-comment tsd-typography"><p>The search engine to use for initializing the module.</p>
270
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">search</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Performs a search operation for the given query.</p>
271
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the search results.</p>
272
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="search-1.__type-190.search-2.__type-195.__type-196"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The search query.</p>
273
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L81">src/index.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="taskplaner" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>taskplaner</span><a href="#taskplaner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">taskplaner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">addTask</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getTasks</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">updateTask</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = task</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add<wbr/>Task</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a task using a WebSocket message.</p>
274
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the add task event.</p>
275
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="taskplaner.__type-197.addTask.__type-198.__type-199"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The task to be added.</p>
276
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Tasks</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves all tasks using a WebSocket message.</p>
277
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the get tasks event.</p>
278
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="taskplaner.__type-197.getTasks.__type-200.__type-201"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">update<wbr/>Task</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Updates an existing task using a WebSocket message.</p>
279
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the update task event.</p>
280
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="taskplaner.__type-197.updateTask.__type-202.__type-203"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">task</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The updated task information.</p>
281
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L89">src/index.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="terminal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>terminal</span><a href="#terminal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">terminal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">eventEmitter</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter-1.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">executeCommand</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">returnEmptyStringOnSuccess</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">executeCommandRunUntilError</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">executeInMain</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CommandError.html" class="tsd-signature-type tsd-kind-interface">CommandError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">executeCommandWithStream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">executeInMain</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.EventEmitter-1.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_internal_.DefaultEventMap.html" class="tsd-signature-type tsd-kind-type-alias">DefaultEventMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-call-signature">sendManualInterrupt</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.TerminalInterruptResponse.html" class="tsd-signature-type tsd-kind-interface">TerminalInterruptResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = cbterminal</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">event<wbr/>Emitter</span><span class="tsd-signature-symbol">: </span><a href="_internal_.CustomEventEmitter-1.html" class="tsd-signature-type tsd-kind-class">CustomEventEmitter</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">execute<wbr/>Command</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">returnEmptyStringOnSuccess</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Executes a given command and returns the result.
282
- Listens for messages from the WebSocket that indicate the output, error, or finish state
283
- of the executed command and resolves the promise accordingly.</p>
284
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the command&#39;s output, error, or finish signal.</p>
285
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="terminal.__type-204.executeCommand.__type-205.__type-206"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">returnEmptyStringOnSuccess</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The command to be executed.</p>
286
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">returnEmptyStringOnSuccess</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">execute<wbr/>Command<wbr/>Run<wbr/>Until<wbr/>Error</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">executeInMain</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CommandError.html" class="tsd-signature-type tsd-kind-interface">CommandError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Executes a given command and keeps running until an error occurs.
287
- Listens for messages from the WebSocket and resolves the promise when an error is encountered.</p>
288
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when an error occurs during command execution.</p>
289
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="terminal.__type-204.executeCommandRunUntilError.__type-207.__type-208"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">executeInMain</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CommandError.html" class="tsd-signature-type tsd-kind-interface">CommandError</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The command to be executed.</p>
290
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">executeInMain</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.CommandError.html" class="tsd-signature-type tsd-kind-interface">CommandError</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">execute<wbr/>Command<wbr/>With<wbr/>Stream</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="terminal.__type-204.executeCommandWithStream.executeCommandWithStream-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">execute<wbr/>Command<wbr/>With<wbr/>Stream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">command</span>, <span class="tsd-kind-parameter">executeInMain</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.EventEmitter-1.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_internal_.DefaultEventMap.html" class="tsd-signature-type tsd-kind-type-alias">DefaultEventMap</a><span class="tsd-signature-symbol">&gt;</span><a href="#terminal.__type-204.executeCommandWithStream.executeCommandWithStream-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Executes a given command and streams the output.
291
- Listens for messages from the WebSocket and streams the output data.</p>
292
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">command</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The command to be executed.</p>
293
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">executeInMain</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_internal_.EventEmitter-1.html" class="tsd-signature-type tsd-kind-class">EventEmitter</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/_internal_.DefaultEventMap.html" class="tsd-signature-type tsd-kind-type-alias">DefaultEventMap</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that streams the output data during command execution.</p>
294
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/modules/terminal.ts#L90">src/modules/terminal.ts:90</a></li></ul></aside></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">send<wbr/>Manual<wbr/>Interrupt</span><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="terminal.__type-204.sendManualInterrupt.sendManualInterrupt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Manual<wbr/>Interrupt</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.TerminalInterruptResponse.html" class="tsd-signature-type tsd-kind-interface">TerminalInterruptResponse</a><span class="tsd-signature-symbol">&gt;</span><a href="#terminal.__type-204.sendManualInterrupt.sendManualInterrupt-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a manual interrupt signal to the terminal.</p>
295
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.TerminalInterruptResponse.html" class="tsd-signature-type tsd-kind-interface">TerminalInterruptResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/modules/terminal.ts#L68">src/modules/terminal.ts:68</a></li></ul></aside></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L77">src/index.ts:77</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tokenizer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tokenizer</span><a href="#tokenizer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tokenizer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">addToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddTokenResponse.html" class="tsd-signature-type tsd-kind-interface">AddTokenResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getToken</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetTokenResponse.html" class="tsd-signature-type tsd-kind-interface">GetTokenResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = tokenizer</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddTokenResponse.html" class="tsd-signature-type tsd-kind-interface">AddTokenResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a token to the system via WebSocket.</p>
296
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the add token event.</p>
297
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="tokenizer.__type-209.addToken.__type-210.__type-211"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddTokenResponse.html" class="tsd-signature-type tsd-kind-interface">AddTokenResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key associated with the token to be added.</p>
298
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddTokenResponse.html" class="tsd-signature-type tsd-kind-interface">AddTokenResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetTokenResponse.html" class="tsd-signature-type tsd-kind-interface">GetTokenResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves a token from the system via WebSocket.</p>
299
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the response from the get token event.</p>
300
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="tokenizer.__type-209.getToken.__type-212.__type-213"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetTokenResponse.html" class="tsd-signature-type tsd-kind-interface">GetTokenResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key associated with the token to be retrieved.</p>
301
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetTokenResponse.html" class="tsd-signature-type tsd-kind-interface">GetTokenResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L92">src/index.ts:92</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="vectordb" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>vectordb</span><a href="#vectordb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vectordb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">addVectorItem</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">AddVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getVector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetVectorResponse.html" class="tsd-signature-type tsd-kind-interface">GetVectorResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">queryVectorItem</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">queryVectorItems</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span>, <span class="tsd-kind-parameter">dbPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = vectorDB</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">add<wbr/>Vector<wbr/>Item</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">AddVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Adds a new vector item to the vector database.</p>
302
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves when the item is successfully added.</p>
303
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="vectordb.__type-214.addVectorItem.__type-215.__type-216"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">item</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">AddVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">item</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The item to add to the vector.</p>
304
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.AddVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">AddVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetVectorResponse.html" class="tsd-signature-type tsd-kind-interface">GetVectorResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Retrieves a vector from the vector database based on the provided key.</p>
305
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the retrieved vector.</p>
306
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="vectordb.__type-214.getVector.__type-217.__type-218"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetVectorResponse.html" class="tsd-signature-type tsd-kind-interface">GetVectorResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key of the vector to retrieve.</p>
307
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.GetVectorResponse.html" class="tsd-signature-type tsd-kind-interface">GetVectorResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">query<wbr/>Vector<wbr/>Item</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Queries a vector item from the vector database based on the provided key.</p>
308
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the queried vector item.</p>
309
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="vectordb.__type-214.queryVectorItem.__type-219.__type-220"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The key of the vector to query the item from.</p>
310
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">query<wbr/>Vector<wbr/>Items</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span>, <span class="tsd-kind-parameter">dbPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><p>Queries a vector item from the vector database based on the provided key.</p>
311
- </div><div class="tsd-comment tsd-typography"><h4>Returns</h4><p>A promise that resolves with the queried vector item.</p>
312
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="vectordb.__type-214.queryVectorItems.__type-221.__type-222"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">items</span>, <span class="tsd-kind-parameter">dbPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li><li><span><span class="tsd-kind-parameter">dbPath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_internal_.QueryVectorItemResponse.html" class="tsd-signature-type tsd-kind-interface">QueryVectorItemResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L90">src/index.ts:90</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="websocket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>websocket</span><a href="#websocket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">websocket</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.WebSocket-1.html" class="tsd-signature-type tsd-kind-class">WebSocket</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L71">src/index.ts:71</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="waitForConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>wait<wbr/>For<wbr/>Connection</span><a href="#waitForConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="waitForConnection.waitForConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>For<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#waitForConnection.waitForConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves when the WebSocket connection is open.</p>
313
- <div class="tsd-comment tsd-typography"><h4>Method</h4><p>waitForConnection</p>
314
- <h4>Description</h4><p>Waits for the WebSocket connection to open.</p>
315
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codeboltai/codeboltjs/blob/fc616ca8b734410fdb13cf3c24bb0f80956be672/src/index.ts#L48">src/index.ts:48</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#browser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>browser</span></a><a href="#cbstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cbstate</span></a><a href="#chat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chat</span></a><a href="#chatSummary" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>chat<wbr/>Summary</span></a><a href="#codeparsers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>codeparsers</span></a><a href="#codeutils" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>codeutils</span></a><a href="#crawler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crawler</span></a><a href="#dbmemory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dbmemory</span></a><a href="#debug" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a><a href="#docutils" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docutils</span></a><a href="#fs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fs</span></a><a href="#git" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git</span></a><a href="#knowledge" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>knowledge</span></a><a href="#llm" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>llm</span></a><a href="#outputparsers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outputparsers</span></a><a href="#project" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project</span></a><a href="#rag" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rag</span></a><a href="#search-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search</span></a><a href="#taskplaner" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>taskplaner</span></a><a href="#terminal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>terminal</span></a><a href="#tokenizer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokenizer</span></a><a href="#vectordb" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vectordb</span></a><a href="#websocket" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>websocket</span></a><a href="#waitForConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>wait<wbr/>For<wbr/>Connection</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@codebolt/codeboltjs</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>