@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/interfaces/_internal_.WebSocket.AddressInfo.html DELETED
@@ -1,4 +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>AddressInfo | @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="../modules/_internal_.WebSocket.html">WebSocket</a></li><li><a href="_internal_.WebSocket.AddressInfo.html">AddressInfo</a></li></ul><h1>Interface AddressInfo</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">AddressInfo</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.AddressInfo.html#address">address</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.AddressInfo.html#family">family</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.AddressInfo.html#port">port</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:336</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">Properties</h3><div class="tsd-index-list"><a href="_internal_.WebSocket.AddressInfo.html#address" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address</span></a>
2
- <a href="_internal_.WebSocket.AddressInfo.html#family" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family</span></a>
3
- <a href="_internal_.WebSocket.AddressInfo.html#port" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port</span></a>
4
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address</span><a href="#address" 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">address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:337</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="family" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>family</span><a href="#family" 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">family</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:338</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>port</span><a href="#port" 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">port</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:339</li></ul></aside></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="#address" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address</span></a><a href="#family" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family</span></a><a href="#port" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port</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>
package/docs/interfaces/_internal_.WebSocket.ClientOptions.html DELETED
@@ -1,138 +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>ClientOptions | @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="../modules/_internal_.WebSocket.html">WebSocket</a></li><li><a href="_internal_.WebSocket.ClientOptions.html">ClientOptions</a></li></ul><h1>Interface ClientOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ClientOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#ALPNCallback">ALPNCallback</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#agent">agent</a><span class="tsd-signature-symbol">?: </span><a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#ca">ca</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#cert">cert</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#ciphers">ciphers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#clientCertEngine">clientCertEngine</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#crl">crl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#dhparam">dhparam</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#ecdhCurve">ecdhCurve</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#family">family</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#followRedirects">followRedirects</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#handshakeTimeout">handshakeTimeout</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</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><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#honorCipherOrder">honorCipherOrder</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#host">host</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#key">key</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol"> | </span><a href="_internal_.KeyObject-1.html" class="tsd-signature-type tsd-kind-interface">KeyObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#localAddress">localAddress</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#maxPayload">maxPayload</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#maxRedirects">maxRedirects</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#maxVersion">maxVersion</a><span class="tsd-signature-symbol">?: </span><a href="../types/_internal_.SecureVersion.html" class="tsd-signature-type tsd-kind-type-alias">SecureVersion</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#minVersion">minVersion</a><span class="tsd-signature-symbol">?: </span><a href="../types/_internal_.SecureVersion.html" class="tsd-signature-type tsd-kind-type-alias">SecureVersion</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#origin">origin</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#passphrase">passphrase</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#perMessageDeflate">perMessageDeflate</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.WebSocket.PerMessageDeflateOptions.html" class="tsd-signature-type tsd-kind-interface">PerMessageDeflateOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#pfx">pfx</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol"> | </span><a href="_internal_.PxfObject.html" class="tsd-signature-type tsd-kind-interface">PxfObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#privateKeyEngine">privateKeyEngine</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#privateKeyIdentifier">privateKeyIdentifier</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#protocol">protocol</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#protocolVersion">protocolVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#rejectUnauthorized">rejectUnauthorized</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#secureOptions">secureOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#secureProtocol">secureProtocol</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#sessionIdContext">sessionIdContext</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#sessionTimeout">sessionTimeout</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#sigalgs">sigalgs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#skipUTF8Validation">skipUTF8Validation</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ClientOptions.html#ticketKeys">ticketKeys</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="_internal_.WebSocket.ClientOptions.html#checkServerIdentity.checkServerIdentity-1">checkServerIdentity</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">servername</span>, <span class="tsd-kind-parameter">cert</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-call-signature" href="_internal_.WebSocket.ClientOptions.html#generateMask.generateMask-1">generateMask</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mask</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#<internal>.WebSocket.ClientOptions">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="_internal_.SecureContextOptions.html" class="tsd-signature-type tsd-kind-interface">SecureContextOptions</a><ul class="tsd-hierarchy"><li><span class="target">ClientOptions</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:243</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">Properties</h3><div class="tsd-index-list"><a href="_internal_.WebSocket.ClientOptions.html#ALPNCallback" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ALPNCallback?</span></a>
2
- <a href="_internal_.WebSocket.ClientOptions.html#agent" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent?</span></a>
3
- <a href="_internal_.WebSocket.ClientOptions.html#ca" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ca?</span></a>
4
- <a href="_internal_.WebSocket.ClientOptions.html#cert" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cert?</span></a>
5
- <a href="_internal_.WebSocket.ClientOptions.html#ciphers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ciphers?</span></a>
6
- <a href="_internal_.WebSocket.ClientOptions.html#clientCertEngine" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Cert<wbr/>Engine?</span></a>
7
- <a href="_internal_.WebSocket.ClientOptions.html#crl" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crl?</span></a>
8
- <a href="_internal_.WebSocket.ClientOptions.html#dhparam" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dhparam?</span></a>
9
- <a href="_internal_.WebSocket.ClientOptions.html#ecdhCurve" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ecdh<wbr/>Curve?</span></a>
10
- <a href="_internal_.WebSocket.ClientOptions.html#family" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family?</span></a>
11
- <a href="_internal_.WebSocket.ClientOptions.html#followRedirects" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>follow<wbr/>Redirects?</span></a>
12
- <a href="_internal_.WebSocket.ClientOptions.html#handshakeTimeout" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handshake<wbr/>Timeout?</span></a>
13
- <a href="_internal_.WebSocket.ClientOptions.html#headers" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers?</span></a>
14
- <a href="_internal_.WebSocket.ClientOptions.html#honorCipherOrder" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>honor<wbr/>Cipher<wbr/>Order?</span></a>
15
- <a href="_internal_.WebSocket.ClientOptions.html#host" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host?</span></a>
16
- <a href="_internal_.WebSocket.ClientOptions.html#key" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key?</span></a>
17
- <a href="_internal_.WebSocket.ClientOptions.html#localAddress" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Address?</span></a>
18
- <a href="_internal_.WebSocket.ClientOptions.html#maxPayload" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Payload?</span></a>
19
- <a href="_internal_.WebSocket.ClientOptions.html#maxRedirects" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Redirects?</span></a>
20
- <a href="_internal_.WebSocket.ClientOptions.html#maxVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Version?</span></a>
21
- <a href="_internal_.WebSocket.ClientOptions.html#minVersion" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Version?</span></a>
22
- <a href="_internal_.WebSocket.ClientOptions.html#origin" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>origin?</span></a>
23
- <a href="_internal_.WebSocket.ClientOptions.html#passphrase" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>passphrase?</span></a>
24
- <a href="_internal_.WebSocket.ClientOptions.html#perMessageDeflate" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>per<wbr/>Message<wbr/>Deflate?</span></a>
25
- <a href="_internal_.WebSocket.ClientOptions.html#pfx" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pfx?</span></a>
26
- <a href="_internal_.WebSocket.ClientOptions.html#privateKeyEngine" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key<wbr/>Engine?</span></a>
27
- <a href="_internal_.WebSocket.ClientOptions.html#privateKeyIdentifier" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key<wbr/>Identifier?</span></a>
28
- <a href="_internal_.WebSocket.ClientOptions.html#protocol" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol?</span></a>
29
- <a href="_internal_.WebSocket.ClientOptions.html#protocolVersion" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol<wbr/>Version?</span></a>
30
- <a href="_internal_.WebSocket.ClientOptions.html#rejectUnauthorized" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject<wbr/>Unauthorized?</span></a>
31
- <a href="_internal_.WebSocket.ClientOptions.html#secureOptions" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secure<wbr/>Options?</span></a>
32
- <a href="_internal_.WebSocket.ClientOptions.html#secureProtocol" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secure<wbr/>Protocol?</span></a>
33
- <a href="_internal_.WebSocket.ClientOptions.html#sessionIdContext" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>Id<wbr/>Context?</span></a>
34
- <a href="_internal_.WebSocket.ClientOptions.html#sessionTimeout" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>Timeout?</span></a>
35
- <a href="_internal_.WebSocket.ClientOptions.html#sigalgs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sigalgs?</span></a>
36
- <a href="_internal_.WebSocket.ClientOptions.html#skipUTF8Validation" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skipUTF8<wbr/>Validation?</span></a>
37
- <a href="_internal_.WebSocket.ClientOptions.html#ticketKeys" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ticket<wbr/>Keys?</span></a>
38
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_internal_.WebSocket.ClientOptions.html#checkServerIdentity" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Server<wbr/>Identity?</span></a>
39
- <a href="_internal_.WebSocket.ClientOptions.html#generateMask" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Mask?</span></a>
40
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ALPNCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ALPNCallback</span><a href="#ALPNCallback" 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">ALPNCallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>If set, this will be called when a client opens a connection using the ALPN extension.
41
- One argument will be passed to the callback: an object containing <code>servername</code> and <code>protocols</code> fields,
42
- respectively containing the server name from the SNI extension (if any) and an array of
43
- ALPN protocol name strings. The callback must return either one of the strings listed in <code>protocols</code>,
44
- which will be returned to the client as the selected ALPN protocol, or <code>undefined</code>,
45
- to reject the connection with a fatal alert. If a string is returned that does not match one of
46
- the client&#39;s ALPN protocols, an error will be thrown.
47
- This option cannot be used with the <code>ALPNProtocols</code> option, and setting both options will throw an error.</p>
48
- </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature" id="ALPNCallback.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</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><span class="tsd-signature-type">string</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">arg</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">protocols</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">servername</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><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">protocols</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">servername</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#ALPNCallback">ALPNCallback</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:811</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="agent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>agent</span><a href="#agent" 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">agent</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:254</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ca" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ca</span><a href="#ca" 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">ca</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Optionally override the trusted CA certificates. Default is to trust
49
- the well-known CAs curated by Mozilla. Mozilla&#39;s CAs are completely
50
- replaced when CAs are explicitly specified using this option.</p>
51
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#ca">ca</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:817</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cert</span><a href="#cert" 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">cert</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Cert chains in PEM format. One cert chain should be provided per
52
- private key. Each cert chain should consist of the PEM formatted
53
- certificate for a provided private key, followed by the PEM
54
- formatted intermediate certificates (if any), in order, and not
55
- including the root CA (the root CA must be pre-known to the peer,
56
- see ca). When providing multiple cert chains, they do not have to
57
- be in the same order as their private keys in key. If the
58
- intermediate certificates are not provided, the peer will not be
59
- able to validate the certificate, and the handshake will fail.</p>
60
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#cert">cert</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:829</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ciphers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ciphers</span><a href="#ciphers" 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">ciphers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Cipher suite specification, replacing the default. For more
61
- information, see modifying the default cipher suite. Permitted
62
- ciphers can be obtained via tls.getCiphers(). Cipher names must be
63
- uppercased in order for OpenSSL to accept them.</p>
64
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#ciphers">ciphers</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:843</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clientCertEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>client<wbr/>Cert<wbr/>Engine</span><a href="#clientCertEngine" 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">client<wbr/>Cert<wbr/>Engine</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of an OpenSSL engine which can provide the client certificate.</p>
65
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#clientCertEngine">clientCertEngine</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:847</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="crl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>crl</span><a href="#crl" 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">crl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>PEM formatted CRLs (Certificate Revocation Lists).</p>
66
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#crl">crl</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:851</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="dhparam" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>dhparam</span><a href="#dhparam" 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">dhparam</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></div><div class="tsd-comment tsd-typography"><p><code>&#39;auto&#39;</code> or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy.
67
- If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
68
- ECDHE-based perfect forward secrecy will still be available.</p>
69
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#dhparam">dhparam</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:857</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ecdhCurve" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ecdh<wbr/>Curve</span><a href="#ecdhCurve" 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">ecdh<wbr/>Curve</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A string describing a named curve or a colon separated list of curve
70
- NIDs or names, for example P-521:P-384:P-256, to use for ECDH key
71
- agreement. Set to auto to select the curve automatically. Use
72
- crypto.getCurves() to obtain a list of available curve names. On
73
- recent releases, openssl ecparam -list_curves will also display the
74
- name and description of each available elliptic curve. Default:
75
- tls.DEFAULT_ECDH_CURVE.</p>
76
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#ecdhCurve">ecdhCurve</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:867</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="family" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>family</span><a href="#family" 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">family</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:256</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="followRedirects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>follow<wbr/>Redirects</span><a href="#followRedirects" 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">follow<wbr/>Redirects</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:245</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="handshakeTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>handshake<wbr/>Timeout</span><a href="#handshakeTimeout" 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">handshake<wbr/>Timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:247</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="headers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>headers</span><a href="#headers" 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">headers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</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></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5></li></ul></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:252</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="honorCipherOrder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>honor<wbr/>Cipher<wbr/>Order</span><a href="#honorCipherOrder" 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">honor<wbr/>Cipher<wbr/>Order</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Attempt to use the server&#39;s cipher suite preferences instead of the
77
- client&#39;s. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be
78
- set in secureOptions</p>
79
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#honorCipherOrder">honorCipherOrder</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:873</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="host" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>host</span><a href="#host" 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">host</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:255</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>key</span><a href="#key" 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">key</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol"> | </span><a href="_internal_.KeyObject-1.html" class="tsd-signature-type tsd-kind-interface">KeyObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Private keys in PEM format. PEM allows the option of private keys
80
- being encrypted. Encrypted keys will be decrypted with
81
- options.passphrase. Multiple keys using different algorithms can be
82
- provided either as an array of unencrypted key strings or buffers,
83
- or an array of objects in the form {pem: &lt;string|buffer&gt;[,
84
- passphrase: <string>]}. The object form can only occur in an array.
85
- object.passphrase is optional. Encrypted keys will be decrypted with
86
- object.passphrase if provided, or options.passphrase if it is not.</p>
87
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#key">key</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:884</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="localAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>local<wbr/>Address</span><a href="#localAddress" 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">local<wbr/>Address</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:250</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="maxPayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Payload</span><a href="#maxPayload" 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">max<wbr/>Payload</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:259</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="maxRedirects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Redirects</span><a href="#maxRedirects" 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">max<wbr/>Redirects</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:248</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="maxVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Version</span><a href="#maxVersion" 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">max<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_internal_.SecureVersion.html" class="tsd-signature-type tsd-kind-type-alias">SecureVersion</a></div><div class="tsd-comment tsd-typography"><p>Optionally set the maximum TLS version to allow. One
88
- of <code>&#39;TLSv1.3&#39;</code>, <code>&#39;TLSv1.2&#39;</code>, <code>&#39;TLSv1.1&#39;</code>, or <code>&#39;TLSv1&#39;</code>. Cannot be specified along with the
89
- <code>secureProtocol</code> option, use one or the other.
90
- <strong>Default:</strong> <code>&#39;TLSv1.3&#39;</code>, unless changed using CLI options. Using
91
- <code>--tls-max-v1.2</code> sets the default to <code>&#39;TLSv1.2&#39;</code>. Using <code>--tls-max-v1.3</code> sets the default to
92
- <code>&#39;TLSv1.3&#39;</code>. If multiple of the options are provided, the highest maximum is used.</p>
93
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#maxVersion">maxVersion</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:904</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="minVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>min<wbr/>Version</span><a href="#minVersion" 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">min<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_internal_.SecureVersion.html" class="tsd-signature-type tsd-kind-type-alias">SecureVersion</a></div><div class="tsd-comment tsd-typography"><p>Optionally set the minimum TLS version to allow. One
94
- of <code>&#39;TLSv1.3&#39;</code>, <code>&#39;TLSv1.2&#39;</code>, <code>&#39;TLSv1.1&#39;</code>, or <code>&#39;TLSv1&#39;</code>. Cannot be specified along with the
95
- <code>secureProtocol</code> option, use one or the other. It is not recommended to use
96
- less than TLSv1.2, but it may be required for interoperability.
97
- <strong>Default:</strong> <code>&#39;TLSv1.2&#39;</code>, unless changed using CLI options. Using
98
- <code>--tls-v1.0</code> sets the default to <code>&#39;TLSv1&#39;</code>. Using <code>--tls-v1.1</code> sets the default to
99
- <code>&#39;TLSv1.1&#39;</code>. Using <code>--tls-min-v1.3</code> sets the default to
100
- &#39;TLSv1.3&#39;. If multiple of the options are provided, the lowest minimum is used.</p>
101
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#minVersion">minVersion</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:915</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="origin" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>origin</span><a href="#origin" 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">origin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:253</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="passphrase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>passphrase</span><a href="#passphrase" 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">passphrase</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Shared passphrase used for a single private key and/or a PFX.</p>
102
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#passphrase">passphrase</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:919</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="perMessageDeflate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>per<wbr/>Message<wbr/>Deflate</span><a href="#perMessageDeflate" 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">per<wbr/>Message<wbr/>Deflate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.WebSocket.PerMessageDeflateOptions.html" class="tsd-signature-type tsd-kind-interface">PerMessageDeflateOptions</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:249</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pfx" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>pfx</span><a href="#pfx" 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">pfx</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><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><a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a><span class="tsd-signature-symbol"> | </span><a href="_internal_.PxfObject.html" class="tsd-signature-type tsd-kind-interface">PxfObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>PFX or PKCS12 encoded private key and certificate chain. pfx is an
103
- alternative to providing key and cert individually. PFX is usually
104
- encrypted, if it is, passphrase will be used to decrypt it. Multiple
105
- PFX can be provided either as an array of unencrypted PFX buffers,
106
- or an array of objects in the form {buf: &lt;string|buffer&gt;[,
107
- passphrase: <string>]}. The object form can only occur in an array.
108
- object.passphrase is optional. Encrypted PFX will be decrypted with
109
- object.passphrase if provided, or options.passphrase if it is not.</p>
110
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#pfx">pfx</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:930</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="privateKeyEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>private<wbr/>Key<wbr/>Engine</span><a href="#privateKeyEngine" 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">private<wbr/>Key<wbr/>Engine</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of an OpenSSL engine to get private key from. Should be used
111
- together with privateKeyIdentifier.</p>
112
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#privateKeyEngine">privateKeyEngine</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:889</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="privateKeyIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>private<wbr/>Key<wbr/>Identifier</span><a href="#privateKeyIdentifier" 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">private<wbr/>Key<wbr/>Identifier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Identifier of a private key managed by an OpenSSL engine. Should be
113
- used together with privateKeyEngine. Should not be set together with
114
- key, because both options define a private key in different ways.</p>
115
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#privateKeyIdentifier">privateKeyIdentifier</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:895</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="protocol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>protocol</span><a href="#protocol" 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">protocol</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:244</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="protocolVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>protocol<wbr/>Version</span><a href="#protocolVersion" 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">protocol<wbr/>Version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:251</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="rejectUnauthorized" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reject<wbr/>Unauthorized</span><a href="#rejectUnauthorized" 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">reject<wbr/>Unauthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:258</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="secureOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>secure<wbr/>Options</span><a href="#secureOptions" 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">secure<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Optionally affect the OpenSSL protocol behavior, which is not
116
- usually necessary. This should be used carefully if at all! Value is
117
- a numeric bitmask of the SSL_OP_* options from OpenSSL Options</p>
118
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#secureOptions">secureOptions</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:936</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="secureProtocol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>secure<wbr/>Protocol</span><a href="#secureProtocol" 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">secure<wbr/>Protocol</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Legacy mechanism to select the TLS protocol version to use, it does
119
- not support independent control of the minimum and maximum version,
120
- and does not support limiting the protocol to TLSv1.3. Use
121
- minVersion and maxVersion instead. The possible values are listed as
122
- SSL_METHODS, use the function names as strings. For example, use
123
- &#39;TLSv1_1_method&#39; to force TLS version 1.1, or &#39;TLS_method&#39; to allow
124
- any TLS protocol version up to TLSv1.3. It is not recommended to use
125
- TLS versions less than 1.2, but it may be required for
126
- interoperability. Default: none, see minVersion.</p>
127
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#secureProtocol">secureProtocol</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:948</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sessionIdContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>session<wbr/>Id<wbr/>Context</span><a href="#sessionIdContext" 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">session<wbr/>Id<wbr/>Context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Opaque identifier used by servers to ensure session state is not
128
- shared between applications. Unused by clients.</p>
129
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#sessionIdContext">sessionIdContext</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:953</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sessionTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>session<wbr/>Timeout</span><a href="#sessionTimeout" 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">session<wbr/>Timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of seconds after which a TLS session created by the
130
- server will no longer be resumable. See Session Resumption for more
131
- information. Default: 300.</p>
132
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#sessionTimeout">sessionTimeout</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:964</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sigalgs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>sigalgs</span><a href="#sigalgs" 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">sigalgs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Colon-separated list of supported signature algorithms. The list
133
- can contain digest algorithms (SHA256, MD5 etc.), public key
134
- algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g
135
- &#39;RSA+SHA384&#39;) or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).</p>
136
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#sigalgs">sigalgs</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:836</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="skipUTF8Validation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>skipUTF8<wbr/>Validation</span><a href="#skipUTF8Validation" 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">skipUTF8<wbr/>Validation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:260</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ticketKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ticket<wbr/>Keys</span><a href="#ticketKeys" 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">ticket<wbr/>Keys</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></div><div class="tsd-comment tsd-typography"><p>48-bytes of cryptographically strong pseudo-random data.
137
- See Session Resumption for more information.</p>
138
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.SecureContextOptions.html">SecureContextOptions</a>.<a href="_internal_.SecureContextOptions.html#ticketKeys">ticketKeys</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:958</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="checkServerIdentity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>check<wbr/>Server<wbr/>Identity</span><a href="#checkServerIdentity" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="checkServerIdentity.checkServerIdentity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">check<wbr/>Server<wbr/>Identity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">servername</span>, <span class="tsd-kind-parameter">cert</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#checkServerIdentity.checkServerIdentity-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">servername</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">cert</span>: <a href="../types/_internal_.WebSocket.CertMeta.html" class="tsd-signature-type tsd-kind-type-alias">CertMeta</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:257</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><a id="generateMask" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>generate<wbr/>Mask</span><a href="#generateMask" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="generateMask.generateMask-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">generate<wbr/>Mask</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mask</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#generateMask.generateMask-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mask</span>: <a href="_internal_.Buffer.html" class="tsd-signature-type tsd-kind-interface">Buffer</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:246</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="#ALPNCallback" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ALPNCallback</span></a><a href="#agent" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent</span></a><a href="#ca" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ca</span></a><a href="#cert" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cert</span></a><a href="#ciphers" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ciphers</span></a><a href="#clientCertEngine" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Cert<wbr/>Engine</span></a><a href="#crl" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>crl</span></a><a href="#dhparam" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dhparam</span></a><a href="#ecdhCurve" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ecdh<wbr/>Curve</span></a><a href="#family" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family</span></a><a href="#followRedirects" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>follow<wbr/>Redirects</span></a><a href="#handshakeTimeout" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handshake<wbr/>Timeout</span></a><a href="#headers" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers</span></a><a href="#honorCipherOrder" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>honor<wbr/>Cipher<wbr/>Order</span></a><a href="#host" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host</span></a><a href="#key" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key</span></a><a href="#localAddress" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Address</span></a><a href="#maxPayload" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Payload</span></a><a href="#maxRedirects" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Redirects</span></a><a href="#maxVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Version</span></a><a href="#minVersion" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Version</span></a><a href="#origin" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>origin</span></a><a href="#passphrase" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>passphrase</span></a><a href="#perMessageDeflate" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>per<wbr/>Message<wbr/>Deflate</span></a><a href="#pfx" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pfx</span></a><a href="#privateKeyEngine" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key<wbr/>Engine</span></a><a href="#privateKeyIdentifier" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>private<wbr/>Key<wbr/>Identifier</span></a><a href="#protocol" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol</span></a><a href="#protocolVersion" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol<wbr/>Version</span></a><a href="#rejectUnauthorized" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject<wbr/>Unauthorized</span></a><a href="#secureOptions" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secure<wbr/>Options</span></a><a href="#secureProtocol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>secure<wbr/>Protocol</span></a><a href="#sessionIdContext" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>Id<wbr/>Context</span></a><a href="#sessionTimeout" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>Timeout</span></a><a href="#sigalgs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sigalgs</span></a><a href="#skipUTF8Validation" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skipUTF8<wbr/>Validation</span></a><a href="#ticketKeys" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ticket<wbr/>Keys</span></a><a href="#checkServerIdentity" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check<wbr/>Server<wbr/>Identity</span></a><a href="#generateMask" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>generate<wbr/>Mask</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>
package/docs/interfaces/_internal_.WebSocket.CloseEvent.html DELETED
@@ -1,6 +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>CloseEvent | @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="../modules/_internal_.WebSocket.html">WebSocket</a></li><li><a href="_internal_.WebSocket.CloseEvent.html">CloseEvent</a></li></ul><h1>Interface CloseEvent</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CloseEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.CloseEvent.html#code">code</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.CloseEvent.html#reason">reason</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.CloseEvent.html#target">target</a><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.WebSocket.html" class="tsd-signature-type tsd-kind-namespace">WebSocket</a><span class="tsd-signature-symbol">.</span><a href="_internal_.WebSocket.WebSocket.html" class="tsd-signature-type tsd-kind-interface">WebSocket</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.CloseEvent.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.CloseEvent.html#wasClean">wasClean</a><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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:296</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">Properties</h3><div class="tsd-index-list"><a href="_internal_.WebSocket.CloseEvent.html#code" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a>
2
- <a href="_internal_.WebSocket.CloseEvent.html#reason" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reason</span></a>
3
- <a href="_internal_.WebSocket.CloseEvent.html#target" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a>
4
- <a href="_internal_.WebSocket.CloseEvent.html#type" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
5
- <a href="_internal_.WebSocket.CloseEvent.html#wasClean" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>was<wbr/>Clean</span></a>
6
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>code</span><a href="#code" 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">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:298</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="reason" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reason</span><a href="#reason" 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">reason</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:299</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.WebSocket.html" class="tsd-signature-type tsd-kind-namespace">WebSocket</a><span class="tsd-signature-symbol">.</span><a href="_internal_.WebSocket.WebSocket.html" class="tsd-signature-type tsd-kind-interface">WebSocket</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:301</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:300</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="wasClean" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>was<wbr/>Clean</span><a href="#wasClean" 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">was<wbr/>Clean</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:297</li></ul></aside></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="#code" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code</span></a><a href="#reason" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reason</span></a><a href="#target" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a><a href="#type" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#wasClean" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>was<wbr/>Clean</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>
package/docs/interfaces/_internal_.WebSocket.ErrorEvent.html DELETED
@@ -1,5 +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>ErrorEvent | @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="../modules/_internal_.WebSocket.html">WebSocket</a></li><li><a href="_internal_.WebSocket.ErrorEvent.html">ErrorEvent</a></li></ul><h1>Interface ErrorEvent</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ErrorEvent</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ErrorEvent.html#error">error</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ErrorEvent.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ErrorEvent.html#target">target</a><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.WebSocket.html" class="tsd-signature-type tsd-kind-namespace">WebSocket</a><span class="tsd-signature-symbol">.</span><a href="_internal_.WebSocket.WebSocket.html" class="tsd-signature-type tsd-kind-interface">WebSocket</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.WebSocket.ErrorEvent.html#type">type</a><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></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:289</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">Properties</h3><div class="tsd-index-list"><a href="_internal_.WebSocket.ErrorEvent.html#error" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a>
2
- <a href="_internal_.WebSocket.ErrorEvent.html#message" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
3
- <a href="_internal_.WebSocket.ErrorEvent.html#target" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a>
4
- <a href="_internal_.WebSocket.ErrorEvent.html#type" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
5
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>error</span><a href="#error" 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">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:290</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:291</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="target" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>target</span><a href="#target" 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">target</span><span class="tsd-signature-symbol">:</span> <a href="../modules/_internal_.WebSocket.html" class="tsd-signature-type tsd-kind-namespace">WebSocket</a><span class="tsd-signature-symbol">.</span><a href="_internal_.WebSocket.WebSocket.html" class="tsd-signature-type tsd-kind-interface">WebSocket</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:293</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/ws/index.d.ts:292</li></ul></aside></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="#error" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a><a href="#message" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#target" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>target</span></a><a href="#type" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>