@codebolt/codeboltjs 2.0.3 → 2.0.5

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 (433) hide show
  1. package/Readme.md +47 -0
  2. package/{modules → dist}/agentlib/agent.js +4 -4
  3. package/{modules → dist}/agentlib/usermessage.js +3 -3
  4. package/dist/core/messageManager.d.ts +47 -0
  5. package/dist/core/messageManager.js +128 -0
  6. package/{modules → dist/core}/websocket.d.ts +5 -0
  7. package/{modules → dist/core}/websocket.js +13 -9
  8. package/{index.d.ts → dist/index.d.ts} +42 -53
  9. package/{index.js → dist/index.js} +49 -4
  10. package/dist/modules/agent.js +79 -0
  11. package/{modules → dist/modules}/browser.d.ts +7 -7
  12. package/dist/modules/browser.js +211 -0
  13. package/{modules → dist/modules}/chat.d.ts +8 -20
  14. package/dist/modules/chat.js +162 -0
  15. package/{modules → dist/modules}/codeutils.d.ts +1 -1
  16. package/dist/modules/codeutils.js +89 -0
  17. package/{modules → dist/modules}/crawler.d.ts +1 -16
  18. package/dist/modules/crawler.js +64 -0
  19. package/dist/modules/dbmemory.js +38 -0
  20. package/dist/modules/debug.js +48 -0
  21. package/{modules → dist/modules}/fs.d.ts +1 -1
  22. package/dist/modules/fs.js +184 -0
  23. package/dist/modules/git.js +152 -0
  24. package/{modules → dist/modules}/history.js +11 -27
  25. package/{modules → dist/modules}/llm.js +8 -16
  26. package/{modules → dist/modules}/project.d.ts +1 -1
  27. package/dist/modules/project.js +48 -0
  28. package/dist/modules/state.js +69 -0
  29. package/dist/modules/task.js +51 -0
  30. package/{modules → dist/modules}/terminal.d.ts +3 -2
  31. package/{modules → dist/modules}/terminal.js +36 -47
  32. package/dist/modules/tokenizer.js +40 -0
  33. package/{modules → dist/modules}/tools.d.ts +0 -6
  34. package/dist/modules/tools.js +117 -0
  35. package/dist/modules/utils.js +22 -0
  36. package/dist/modules/vectordb.js +71 -0
  37. package/dist/utils.d.ts +5 -0
  38. package/{utils.js → dist/utils.js} +5 -5
  39. package/package.json +17 -8
  40. package/.codebolt/chat.json +0 -1
  41. package/.codebolt/debug.json +0 -1
  42. package/.codebolt/projectState.json +0 -127
  43. package/.codebolt/tasks.json +0 -1
  44. package/.codeboltconfig.yaml +0 -0
  45. package/.github/workflows/publish-to-npm.yml +0 -20
  46. package/bkp/toolBox.bkp.ts +0 -1162
  47. package/docs/.nojekyll +0 -1
  48. package/docs/assets/highlight.css +0 -127
  49. package/docs/assets/icons.js +0 -15
  50. package/docs/assets/icons.svg +0 -1
  51. package/docs/assets/main.js +0 -59
  52. package/docs/assets/navigation.js +0 -1
  53. package/docs/assets/search.js +0 -1
  54. package/docs/assets/style.css +0 -1412
  55. package/docs/classes/_internal_.Agent.html +0 -318
  56. package/docs/classes/_internal_.AsyncResource.html +0 -44
  57. package/docs/classes/_internal_.Blob.html +0 -33
  58. package/docs/classes/_internal_.ClientRequest.html +0 -506
  59. package/docs/classes/_internal_.Codebolt.html +0 -315
  60. package/docs/classes/_internal_.CustomEventEmitter-1.html +0 -248
  61. package/docs/classes/_internal_.CustomEventEmitter.html +0 -248
  62. package/docs/classes/_internal_.Duplex.html +0 -690
  63. package/docs/classes/_internal_.EventEmitter-1.html +0 -254
  64. package/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +0 -268
  65. package/docs/classes/_internal_.IncomingMessage.html +0 -661
  66. package/docs/classes/_internal_.KeyObject.html +0 -76
  67. package/docs/classes/_internal_.OutgoingMessage.html +0 -491
  68. package/docs/classes/_internal_.Readable.html +0 -551
  69. package/docs/classes/_internal_.ReadableBase.html +0 -551
  70. package/docs/classes/_internal_.Server-1.html +0 -416
  71. package/docs/classes/_internal_.Server-2.html +0 -326
  72. package/docs/classes/_internal_.Server-3.html +0 -353
  73. package/docs/classes/_internal_.Server.html +0 -390
  74. package/docs/classes/_internal_.ServerResponse.html +0 -569
  75. package/docs/classes/_internal_.Socket.html +0 -791
  76. package/docs/classes/_internal_.Stream.html +0 -256
  77. package/docs/classes/_internal_.TLSSocket.html +0 -947
  78. package/docs/classes/_internal_.URL.html +0 -140
  79. package/docs/classes/_internal_.URLSearchParams.html +0 -68
  80. package/docs/classes/_internal_.WebSocket-1.html +0 -297
  81. package/docs/classes/_internal_.WebSocket.Server.html +0 -261
  82. package/docs/classes/_internal_.Writable.html +0 -394
  83. package/docs/classes/_internal_.WritableBase.html +0 -394
  84. package/docs/classes/_internal_.X509Certificate.html +0 -144
  85. package/docs/classes/_internal_.internal-1.html +0 -256
  86. package/docs/classes/_internal_.internal.PassThrough.html +0 -686
  87. package/docs/classes/_internal_.internal.Transform.html +0 -693
  88. package/docs/enums/_internal_.logType.html +0 -4
  89. package/docs/functions/_internal_.WebSocket.createWebSocketStream.html +0 -1
  90. package/docs/functions/_internal_._node_stream_consumers_.arrayBuffer.html +0 -1
  91. package/docs/functions/_internal_._node_stream_consumers_.blob.html +0 -1
  92. package/docs/functions/_internal_._node_stream_consumers_.buffer.html +0 -1
  93. package/docs/functions/_internal_._node_stream_consumers_.json.html +0 -1
  94. package/docs/functions/_internal_._node_stream_consumers_.text.html +0 -1
  95. package/docs/functions/_internal_._node_stream_promises_.finished.html +0 -1
  96. package/docs/functions/_internal_._node_stream_promises_.pipeline.html +0 -1
  97. package/docs/functions/_internal_.internal.addAbortSignal.html +0 -17
  98. package/docs/functions/_internal_.internal.finished-1.html +0 -20
  99. package/docs/functions/_internal_.internal.finished.__promisify__.html +0 -1
  100. package/docs/functions/_internal_.internal.getDefaultHighWaterMark.html +0 -4
  101. package/docs/functions/_internal_.internal.isErrored.html +0 -3
  102. package/docs/functions/_internal_.internal.isReadable.html +0 -3
  103. package/docs/functions/_internal_.internal.pipeline-1.html +0 -24
  104. package/docs/functions/_internal_.internal.pipeline.__promisify__.html +0 -1
  105. package/docs/functions/_internal_.internal.setDefaultHighWaterMark.html +0 -4
  106. package/docs/hierarchy.html +0 -1
  107. package/docs/index.html +0 -12
  108. package/docs/interfaces/_internal_.AddToAgentStateResponse.html +0 -3
  109. package/docs/interfaces/_internal_.AddTokenResponse.html +0 -3
  110. package/docs/interfaces/_internal_.AddVectorItemResponse.html +0 -3
  111. package/docs/interfaces/_internal_.AddressInfo.html +0 -4
  112. package/docs/interfaces/_internal_.AgentOptions.html +0 -35
  113. package/docs/interfaces/_internal_.ApplicationState.html +0 -4
  114. package/docs/interfaces/_internal_.ArrayBufferView.html +0 -7
  115. package/docs/interfaces/_internal_.ArrayLike.html +0 -2
  116. package/docs/interfaces/_internal_.ArrayOptions.html +0 -7
  117. package/docs/interfaces/_internal_.AsymmetricKeyDetails.html +0 -15
  118. package/docs/interfaces/_internal_.AsyncGenerator.html +0 -5
  119. package/docs/interfaces/_internal_.AsyncGeneratorFunction.html +0 -12
  120. package/docs/interfaces/_internal_.AsyncIterable.html +0 -2
  121. package/docs/interfaces/_internal_.AsyncIterableIterator.html +0 -5
  122. package/docs/interfaces/_internal_.AsyncIterator.html +0 -4
  123. package/docs/interfaces/_internal_.AsyncResourceOptions.html +0 -12
  124. package/docs/interfaces/_internal_.BlobOptions.html +0 -8
  125. package/docs/interfaces/_internal_.Buffer.html +0 -760
  126. package/docs/interfaces/_internal_.BufferConstructor.html +0 -165
  127. package/docs/interfaces/_internal_.Certificate.html +0 -13
  128. package/docs/interfaces/_internal_.ChatMessage.html +0 -3
  129. package/docs/interfaces/_internal_.Choice.html +0 -5
  130. package/docs/interfaces/_internal_.CipherNameAndProtocol.html +0 -7
  131. package/docs/interfaces/_internal_.ClientRequestArgs.html +0 -28
  132. package/docs/interfaces/_internal_.CommandError.html +0 -3
  133. package/docs/interfaces/_internal_.CommonConnectionOptions.html +0 -29
  134. package/docs/interfaces/_internal_.ConnectOpts.html +0 -5
  135. package/docs/interfaces/_internal_.CreateFileResponse.html +0 -6
  136. package/docs/interfaces/_internal_.CreateFolderResponse.html +0 -6
  137. package/docs/interfaces/_internal_.CryptoKey.html +0 -26
  138. package/docs/interfaces/_internal_.DebugAddLogResponse.html +0 -4
  139. package/docs/interfaces/_internal_.DeleteFileResponse.html +0 -6
  140. package/docs/interfaces/_internal_.DeleteFolderResponse.html +0 -6
  141. package/docs/interfaces/_internal_.DetailedPeerCertificate.html +0 -53
  142. package/docs/interfaces/_internal_.Dict.html +0 -1
  143. package/docs/interfaces/_internal_.Disposable.html +0 -2
  144. package/docs/interfaces/_internal_.DropArgument.html +0 -7
  145. package/docs/interfaces/_internal_.DuplexOptions.html +0 -22
  146. package/docs/interfaces/_internal_.EphemeralKeyInfo.html +0 -7
  147. package/docs/interfaces/_internal_.ErrnoException.html +0 -8
  148. package/docs/interfaces/_internal_.Error.html +0 -4
  149. package/docs/interfaces/_internal_.EventEmitter-2.html +0 -130
  150. package/docs/interfaces/_internal_.EventEmitter.Abortable.html +0 -3
  151. package/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +0 -19
  152. package/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +0 -32
  153. package/docs/interfaces/_internal_.EventEmitterOptions.html +0 -3
  154. package/docs/interfaces/_internal_.ExtractTextResponse.html +0 -3
  155. package/docs/interfaces/_internal_.GetAgentStateResponse.html +0 -3
  156. package/docs/interfaces/_internal_.GetContentResponse.html +0 -3
  157. package/docs/interfaces/_internal_.GetMarkdownResponse.html +0 -3
  158. package/docs/interfaces/_internal_.GetMatcherListTreeResponse.html +0 -3
  159. package/docs/interfaces/_internal_.GetProjectPathResponse.html +0 -5
  160. package/docs/interfaces/_internal_.GetTokenResponse.html +0 -3
  161. package/docs/interfaces/_internal_.GetVectorResponse.html +0 -3
  162. package/docs/interfaces/_internal_.GoToPageResponse.html +0 -3
  163. package/docs/interfaces/_internal_.HtmlReceived.html +0 -3
  164. package/docs/interfaces/_internal_.IncomingHttpHeaders.html +0 -64
  165. package/docs/interfaces/_internal_.InformationEvent.html +0 -8
  166. package/docs/interfaces/_internal_.IpcSocketConnectOpts.html +0 -6
  167. package/docs/interfaces/_internal_.Iterable.html +0 -2
  168. package/docs/interfaces/_internal_.IterableIterator.html +0 -5
  169. package/docs/interfaces/_internal_.Iterator.html +0 -4
  170. package/docs/interfaces/_internal_.IteratorReturnResult.html +0 -3
  171. package/docs/interfaces/_internal_.IteratorYieldResult.html +0 -3
  172. package/docs/interfaces/_internal_.JsonWebKey.html +0 -14
  173. package/docs/interfaces/_internal_.JwkKeyExportOptions.html +0 -2
  174. package/docs/interfaces/_internal_.KeyAlgorithm.html +0 -2
  175. package/docs/interfaces/_internal_.KeyExportOptions.html +0 -5
  176. package/docs/interfaces/_internal_.KeyObject-1.html +0 -5
  177. package/docs/interfaces/_internal_.LLMResponse.html +0 -4
  178. package/docs/interfaces/_internal_.ListenOptions.html +0 -13
  179. package/docs/interfaces/_internal_.LookupAddress.html +0 -6
  180. package/docs/interfaces/_internal_.LookupOptions.html +0 -27
  181. package/docs/interfaces/_internal_.MatchProblemResponse.html +0 -3
  182. package/docs/interfaces/_internal_.MemoryGetResponse.html +0 -5
  183. package/docs/interfaces/_internal_.MemorySetResponse.html +0 -5
  184. package/docs/interfaces/_internal_.Message.html +0 -8
  185. package/docs/interfaces/_internal_.MessageContent.html +0 -3
  186. package/docs/interfaces/_internal_.Object.html +0 -18
  187. package/docs/interfaces/_internal_.OnReadOpts.html +0 -6
  188. package/docs/interfaces/_internal_.OpenDebugBrowserResponse.html +0 -4
  189. package/docs/interfaces/_internal_.OutgoingHttpHeaders.html +0 -80
  190. package/docs/interfaces/_internal_.PeerCertificate.html +0 -50
  191. package/docs/interfaces/_internal_.PromiseLike.html +0 -6
  192. package/docs/interfaces/_internal_.PxfObject.html +0 -5
  193. package/docs/interfaces/_internal_.QueryVectorItemResponse.html +0 -3
  194. package/docs/interfaces/_internal_.QueuingStrategy.html +0 -3
  195. package/docs/interfaces/_internal_.QueuingStrategySize.html +0 -1
  196. package/docs/interfaces/_internal_.ReadFileResponse.html +0 -7
  197. package/docs/interfaces/_internal_.ReadOnlyDict.html +0 -1
  198. package/docs/interfaces/_internal_.ReadWriteStream.html +0 -144
  199. package/docs/interfaces/_internal_.ReadableByteStreamController.html +0 -6
  200. package/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html +0 -1
  201. package/docs/interfaces/_internal_.ReadableOptions.html +0 -11
  202. package/docs/interfaces/_internal_.ReadableStream-1.html +0 -141
  203. package/docs/interfaces/_internal_.ReadableStream.html +0 -10
  204. package/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +0 -5
  205. package/docs/interfaces/_internal_.ReadableStreamDefaultController.html +0 -5
  206. package/docs/interfaces/_internal_.ReadableStreamDefaultReadDoneResult.html +0 -3
  207. package/docs/interfaces/_internal_.ReadableStreamDefaultReadValueResult.html +0 -3
  208. package/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +0 -5
  209. package/docs/interfaces/_internal_.ReadableStreamErrorCallback.html +0 -1
  210. package/docs/interfaces/_internal_.ReadableStreamGenericReader.html +0 -3
  211. package/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html +0 -3
  212. package/docs/interfaces/_internal_.ReadableStreamReadValueResult.html +0 -3
  213. package/docs/interfaces/_internal_.ReadableWritablePair.html +0 -9
  214. package/docs/interfaces/_internal_.SecureContext.html +0 -2
  215. package/docs/interfaces/_internal_.SecureContextOptions.html +0 -121
  216. package/docs/interfaces/_internal_.Selection.html +0 -6
  217. package/docs/interfaces/_internal_.ServerOptions.html +0 -64
  218. package/docs/interfaces/_internal_.ServerOpts.html +0 -25
  219. package/docs/interfaces/_internal_.SharedArrayBuffer.html +0 -7
  220. package/docs/interfaces/_internal_.SharedArrayBufferConstructor.html +0 -3
  221. package/docs/interfaces/_internal_.SocketConstructorOpts.html +0 -6
  222. package/docs/interfaces/_internal_.StaticEventEmitterOptions.html +0 -15
  223. package/docs/interfaces/_internal_.StreamOptions.html +0 -9
  224. package/docs/interfaces/_internal_.StreamPipeOptions.html +0 -37
  225. package/docs/interfaces/_internal_.TLSSocketOptions.html +0 -160
  226. package/docs/interfaces/_internal_.TcpSocketConnectOpts.html +0 -19
  227. package/docs/interfaces/_internal_.TerminalInterruptResponse.html +0 -3
  228. package/docs/interfaces/_internal_.TlsOptions.html +0 -197
  229. package/docs/interfaces/_internal_.UnderlyingByteSource.html +0 -6
  230. package/docs/interfaces/_internal_.UnderlyingSink.html +0 -6
  231. package/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html +0 -1
  232. package/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html +0 -1
  233. package/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html +0 -1
  234. package/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html +0 -1
  235. package/docs/interfaces/_internal_.UnderlyingSource.html +0 -5
  236. package/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html +0 -1
  237. package/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html +0 -1
  238. package/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html +0 -1
  239. package/docs/interfaces/_internal_.UpdateFileResponse.html +0 -6
  240. package/docs/interfaces/_internal_.UrlResponse.html +0 -3
  241. package/docs/interfaces/_internal_.Usage-1.html +0 -4
  242. package/docs/interfaces/_internal_.Usage.html +0 -4
  243. package/docs/interfaces/_internal_.UserMessage.html +0 -3
  244. package/docs/interfaces/_internal_.UserRequest.html +0 -7
  245. package/docs/interfaces/_internal_.WebSocket.AddressInfo.html +0 -4
  246. package/docs/interfaces/_internal_.WebSocket.ClientOptions.html +0 -138
  247. package/docs/interfaces/_internal_.WebSocket.CloseEvent.html +0 -6
  248. package/docs/interfaces/_internal_.WebSocket.ErrorEvent.html +0 -5
  249. package/docs/interfaces/_internal_.WebSocket.Event.html +0 -3
  250. package/docs/interfaces/_internal_.WebSocket.EventListenerOptions.html +0 -2
  251. package/docs/interfaces/_internal_.WebSocket.MessageEvent.html +0 -4
  252. package/docs/interfaces/_internal_.WebSocket.PerMessageDeflateOptions.html +0 -9
  253. package/docs/interfaces/_internal_.WebSocket.ServerOptions.html +0 -14
  254. package/docs/interfaces/_internal_.WebSocket.WebSocket.html +0 -172
  255. package/docs/interfaces/_internal_.WebSocket.WebSocketServer.html +0 -144
  256. package/docs/interfaces/_internal_.WebSocketAlias.html +0 -172
  257. package/docs/interfaces/_internal_.WritableOptions.html +0 -14
  258. package/docs/interfaces/_internal_.WritableStream-1.html +0 -8
  259. package/docs/interfaces/_internal_.WritableStream.html +0 -133
  260. package/docs/interfaces/_internal_.WritableStreamDefaultController.html +0 -6
  261. package/docs/interfaces/_internal_.WritableStreamDefaultWriter.html +0 -12
  262. package/docs/interfaces/_internal_.X509CheckOptions.html +0 -16
  263. package/docs/interfaces/_internal_.ZlibOptions.html +0 -21
  264. package/docs/interfaces/_internal_.getMatchDetail.html +0 -3
  265. package/docs/interfaces/_internal_.internal.FinishedOptions.html +0 -6
  266. package/docs/interfaces/_internal_.internal.Pipe.html +0 -5
  267. package/docs/interfaces/_internal_.internal.PipelineOptions.html +0 -3
  268. package/docs/interfaces/_internal_.internal.TransformOptions.html +0 -24
  269. package/docs/modules/_internal_.EventEmitter.html +0 -6
  270. package/docs/modules/_internal_.WebSocket.html +0 -21
  271. package/docs/modules/_internal_._node_stream_consumers_.html +0 -6
  272. package/docs/modules/_internal_._node_stream_promises_.html +0 -3
  273. package/docs/modules/_internal_.html +0 -228
  274. package/docs/modules/_internal_.internal.finished.html +0 -2
  275. package/docs/modules/_internal_.internal.html +0 -36
  276. package/docs/modules/_internal_.internal.pipeline.html +0 -2
  277. package/docs/modules.html +0 -3
  278. package/docs/types/_internal_.AnyRest.html +0 -1
  279. package/docs/types/_internal_.Args.html +0 -1
  280. package/docs/types/_internal_.ArrayBufferLike.html +0 -1
  281. package/docs/types/_internal_.ArrayBufferView-1.html +0 -1
  282. package/docs/types/_internal_.BinaryLike.html +0 -1
  283. package/docs/types/_internal_.BufferEncoding.html +0 -1
  284. package/docs/types/_internal_.BufferLike.html +0 -1
  285. package/docs/types/_internal_.ComposeFnParam.html +0 -1
  286. package/docs/types/_internal_.DefaultEventMap.html +0 -1
  287. package/docs/types/_internal_.EventMap.html +0 -1
  288. package/docs/types/_internal_.InstanceType.html +0 -2
  289. package/docs/types/_internal_.IteratorResult.html +0 -1
  290. package/docs/types/_internal_.Key.html +0 -1
  291. package/docs/types/_internal_.Key2.html +0 -1
  292. package/docs/types/_internal_.KeyFormat.html +0 -1
  293. package/docs/types/_internal_.KeyObjectType.html +0 -1
  294. package/docs/types/_internal_.KeyType-1.html +0 -1
  295. package/docs/types/_internal_.KeyType.html +0 -1
  296. package/docs/types/_internal_.KeyUsage.html +0 -1
  297. package/docs/types/_internal_.Listener.html +0 -1
  298. package/docs/types/_internal_.LookupFunction.html +0 -1
  299. package/docs/types/_internal_.OutgoingHttpHeader.html +0 -1
  300. package/docs/types/_internal_.Partial.html +0 -2
  301. package/docs/types/_internal_.Pick.html +0 -2
  302. package/docs/types/_internal_.PropertyKey.html +0 -1
  303. package/docs/types/_internal_.ReadableStreamController.html +0 -1
  304. package/docs/types/_internal_.ReadableStreamDefaultReadResult.html +0 -1
  305. package/docs/types/_internal_.ReadableStreamReadResult.html +0 -1
  306. package/docs/types/_internal_.Record.html +0 -2
  307. package/docs/types/_internal_.RequestListener.html +0 -1
  308. package/docs/types/_internal_.SecureVersion.html +0 -1
  309. package/docs/types/_internal_.ServerOptions-1.html +0 -1
  310. package/docs/types/_internal_.SocketConnectOpts.html +0 -1
  311. package/docs/types/_internal_.SocketReadyState.html +0 -1
  312. package/docs/types/_internal_.TypedArray.html +0 -1
  313. package/docs/types/_internal_.WebSocket.CertMeta.html +0 -2
  314. package/docs/types/_internal_.WebSocket.Data.html +0 -2
  315. package/docs/types/_internal_.WebSocket.RawData.html +0 -2
  316. package/docs/types/_internal_.WebSocket.VerifyClientCallbackAsync.html +0 -4
  317. package/docs/types/_internal_.WebSocket.VerifyClientCallbackSync.html +0 -4
  318. package/docs/types/_internal_.WithImplicitCoercion.html +0 -1
  319. package/docs/types/_internal_.internal.PipelineCallback.html +0 -1
  320. package/docs/types/_internal_.internal.PipelineDestination.html +0 -1
  321. package/docs/types/_internal_.internal.PipelineDestinationIterableFunction.html +0 -1
  322. package/docs/types/_internal_.internal.PipelineDestinationPromiseFunction.html +0 -1
  323. package/docs/types/_internal_.internal.PipelinePromise.html +0 -1
  324. package/docs/types/_internal_.internal.PipelineSource.html +0 -1
  325. package/docs/types/_internal_.internal.PipelineSourceFunction.html +0 -1
  326. package/docs/types/_internal_.internal.PipelineTransform.html +0 -1
  327. package/docs/types/_internal_.internal.PipelineTransformSource.html +0 -1
  328. package/docs/types/_internal_.internal.TransformCallback.html +0 -1
  329. package/docs/variables/_internal_.Buffer-1.html +0 -1
  330. package/docs/variables/_internal_.Error-1.html +0 -1
  331. package/docs/variables/_internal_.Object-1.html +0 -2
  332. package/docs/variables/_internal_.ReadableByteStreamController-1.html +0 -1
  333. package/docs/variables/_internal_.ReadableStream-2.html +0 -1
  334. package/docs/variables/_internal_.ReadableStreamBYOBReader-1.html +0 -1
  335. package/docs/variables/_internal_.ReadableStreamDefaultController-1.html +0 -1
  336. package/docs/variables/_internal_.ReadableStreamDefaultReader-1.html +0 -1
  337. package/docs/variables/_internal_.SharedArrayBuffer-1.html +0 -1
  338. package/docs/variables/_internal_.WebSocket.WebSocket-1.html +0 -1
  339. package/docs/variables/_internal_.WebSocket.WebSocketServer-1.html +0 -1
  340. package/docs/variables/_internal_.WebSocketAlias-1.html +0 -1
  341. package/docs/variables/_internal_.WritableStream-2.html +0 -1
  342. package/docs/variables/_internal_.WritableStreamDefaultController-1.html +0 -1
  343. package/docs/variables/_internal_.WritableStreamDefaultWriter-1.html +0 -1
  344. package/docs/variables/_internal_.internal.consumers.html +0 -1
  345. package/docs/variables/_internal_.internal.promises.html +0 -1
  346. package/docs/variables/default.html +0 -1
  347. package/modules/agent.js +0 -111
  348. package/modules/browser.js +0 -331
  349. package/modules/chat.js +0 -225
  350. package/modules/codeutils.js +0 -166
  351. package/modules/crawler.js +0 -123
  352. package/modules/dbmemory.js +0 -54
  353. package/modules/debug.js +0 -64
  354. package/modules/fs.js +0 -264
  355. package/modules/git.js +0 -240
  356. package/modules/project.js +0 -72
  357. package/modules/state.js +0 -109
  358. package/modules/task.js +0 -75
  359. package/modules/tokenizer.js +0 -56
  360. package/modules/tools.js +0 -255
  361. package/modules/vectordb.js +0 -103
  362. package/script/gen.js +0 -27
  363. package/src/index.ts +0 -108
  364. package/src/modules/agent.ts +0 -120
  365. package/src/modules/agentlib/agent.ts +0 -417
  366. package/src/modules/agentlib/systemprompt.ts +0 -55
  367. package/src/modules/agentlib/taskInstruction.ts +0 -105
  368. package/src/modules/agentlib/usermessage.ts +0 -188
  369. package/src/modules/browser.ts +0 -352
  370. package/src/modules/chat.ts +0 -229
  371. package/src/modules/codeparsers.ts +0 -28
  372. package/src/modules/codeutils.ts +0 -182
  373. package/src/modules/crawler.ts +0 -121
  374. package/src/modules/dbmemory.ts +0 -52
  375. package/src/modules/debug.ts +0 -68
  376. package/src/modules/docutils.ts +0 -18
  377. package/src/modules/fs.ts +0 -263
  378. package/src/modules/git.ts +0 -237
  379. package/src/modules/history.ts +0 -82
  380. package/src/modules/knowledge.ts +0 -5
  381. package/src/modules/llm.ts +0 -36
  382. package/src/modules/outputparsers.ts +0 -30
  383. package/src/modules/project.ts +0 -68
  384. package/src/modules/rag.ts +0 -27
  385. package/src/modules/search.ts +0 -32
  386. package/src/modules/state.ts +0 -115
  387. package/src/modules/task.ts +0 -73
  388. package/src/modules/terminal.ts +0 -113
  389. package/src/modules/tokenizer.ts +0 -56
  390. package/src/modules/toolBox.ts +0 -1384
  391. package/src/modules/tools.ts +0 -254
  392. package/src/modules/vectordb.ts +0 -102
  393. package/src/modules/websocket.ts +0 -97
  394. package/src/utils/editFile.ts +0 -30
  395. package/src/utils.ts +0 -5
  396. package/tests/chat.test.js +0 -0
  397. package/tests/fs.test.js +0 -89
  398. package/tests/index.test.js +0 -4
  399. package/tsconfig.json +0 -122
  400. package/utils/editFile.js +0 -30
  401. package/utils.d.ts +0 -5
  402. package/webpack.config.js +0 -25
  403. /package/{modules → dist}/agentlib/agent.d.ts +0 -0
  404. /package/{modules → dist}/agentlib/systemprompt.d.ts +0 -0
  405. /package/{modules → dist}/agentlib/systemprompt.js +0 -0
  406. /package/{modules → dist}/agentlib/taskInstruction.d.ts +0 -0
  407. /package/{modules → dist}/agentlib/taskInstruction.js +0 -0
  408. /package/{modules → dist}/agentlib/usermessage.d.ts +0 -0
  409. /package/{modules → dist/modules}/agent.d.ts +0 -0
  410. /package/{modules → dist/modules}/codeparsers.d.ts +0 -0
  411. /package/{modules → dist/modules}/codeparsers.js +0 -0
  412. /package/{modules → dist/modules}/dbmemory.d.ts +0 -0
  413. /package/{modules → dist/modules}/debug.d.ts +0 -0
  414. /package/{modules → dist/modules}/docutils.d.ts +0 -0
  415. /package/{modules → dist/modules}/docutils.js +0 -0
  416. /package/{modules → dist/modules}/git.d.ts +0 -0
  417. /package/{modules → dist/modules}/history.d.ts +0 -0
  418. /package/{modules → dist/modules}/knowledge.d.ts +0 -0
  419. /package/{modules → dist/modules}/knowledge.js +0 -0
  420. /package/{modules → dist/modules}/llm.d.ts +0 -0
  421. /package/{modules → dist/modules}/outputparsers.d.ts +0 -0
  422. /package/{modules → dist/modules}/outputparsers.js +0 -0
  423. /package/{modules → dist/modules}/rag.d.ts +0 -0
  424. /package/{modules → dist/modules}/rag.js +0 -0
  425. /package/{modules → dist/modules}/search.d.ts +0 -0
  426. /package/{modules → dist/modules}/search.js +0 -0
  427. /package/{modules → dist/modules}/state.d.ts +0 -0
  428. /package/{modules → dist/modules}/task.d.ts +0 -0
  429. /package/{modules → dist/modules}/tokenizer.d.ts +0 -0
  430. /package/{utils/editFile.d.ts → dist/modules/utils.d.ts} +0 -0
  431. /package/{modules → dist/modules}/vectordb.d.ts +0 -0
  432. /package/{modules → dist/utils}/toolBox.d.ts +0 -0
  433. /package/{modules → dist/utils}/toolBox.js +0 -0
package/docs/interfaces/_internal_.TlsOptions.html DELETED
@@ -1,197 +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>TlsOptions | @codebolt/codeboltjs</title><meta name="description" content="Documentation for @codebolt/codeboltjs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@codebolt/codeboltjs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@codebolt/codeboltjs</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.TlsOptions.html">TlsOptions</a></li></ul><h1>Interface TlsOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TlsOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.TlsOptions.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_.TlsOptions.html#ALPNProtocols">ALPNProtocols</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</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><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.TlsOptions.html#SNICallback">SNICallback</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">servername</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.TlsOptions.html#allowHalfOpen">allowHalfOpen</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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.html#enableTrace">enableTrace</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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.html#keepAlive">keepAlive</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_.TlsOptions.html#keepAliveInitialDelay">keepAliveInitialDelay</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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.html#noDelay">noDelay</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_.TlsOptions.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_.TlsOptions.html#pauseOnConnect">pauseOnConnect</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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.html#pskIdentityHint">pskIdentityHint</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_.TlsOptions.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_.TlsOptions.html#requestCert">requestCert</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_.TlsOptions.html#secureContext">secureContext</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.SecureContext.html" class="tsd-signature-type tsd-kind-interface">SecureContext</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.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_.TlsOptions.html#pskCallback.pskCallback-1">pskCallback</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">socket</span>, <span class="tsd-kind-parameter">identity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DataView</span><span class="tsd-signature-symbol"> | </span><a href="../types/_internal_.TypedArray.html" class="tsd-signature-type tsd-kind-type-alias">TypedArray</a><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>.TlsOptions">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="_internal_.SecureContextOptions.html" class="tsd-signature-type tsd-kind-interface">SecureContextOptions</a></li><li><a href="_internal_.CommonConnectionOptions.html" class="tsd-signature-type tsd-kind-interface">CommonConnectionOptions</a></li><li><a href="_internal_.ServerOpts.html" class="tsd-signature-type tsd-kind-interface">ServerOpts</a><ul class="tsd-hierarchy"><li><span class="target">TlsOptions</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:545</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_.TlsOptions.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_.TlsOptions.html#ALPNProtocols" 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>ALPNProtocols?</span></a>
3
- <a href="_internal_.TlsOptions.html#SNICallback" 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>SNICallback?</span></a>
4
- <a href="_internal_.TlsOptions.html#allowHalfOpen" 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>allow<wbr/>Half<wbr/>Open?</span></a>
5
- <a href="_internal_.TlsOptions.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>
6
- <a href="_internal_.TlsOptions.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>
7
- <a href="_internal_.TlsOptions.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>
8
- <a href="_internal_.TlsOptions.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>
9
- <a href="_internal_.TlsOptions.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>
10
- <a href="_internal_.TlsOptions.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>
11
- <a href="_internal_.TlsOptions.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>
12
- <a href="_internal_.TlsOptions.html#enableTrace" 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>enable<wbr/>Trace?</span></a>
13
- <a href="_internal_.TlsOptions.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>
14
- <a href="_internal_.TlsOptions.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_.TlsOptions.html#keepAlive" 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>keep<wbr/>Alive?</span></a>
16
- <a href="_internal_.TlsOptions.html#keepAliveInitialDelay" 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>keep<wbr/>Alive<wbr/>Initial<wbr/>Delay?</span></a>
17
- <a href="_internal_.TlsOptions.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>
18
- <a href="_internal_.TlsOptions.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>
19
- <a href="_internal_.TlsOptions.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>
20
- <a href="_internal_.TlsOptions.html#noDelay" 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>no<wbr/>Delay?</span></a>
21
- <a href="_internal_.TlsOptions.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>
22
- <a href="_internal_.TlsOptions.html#pauseOnConnect" 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>pause<wbr/>On<wbr/>Connect?</span></a>
23
- <a href="_internal_.TlsOptions.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>
24
- <a href="_internal_.TlsOptions.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>
25
- <a href="_internal_.TlsOptions.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>
26
- <a href="_internal_.TlsOptions.html#pskIdentityHint" 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>psk<wbr/>Identity<wbr/>Hint?</span></a>
27
- <a href="_internal_.TlsOptions.html#rejectUnauthorized" 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>reject<wbr/>Unauthorized?</span></a>
28
- <a href="_internal_.TlsOptions.html#requestCert" 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>request<wbr/>Cert?</span></a>
29
- <a href="_internal_.TlsOptions.html#secureContext" 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/>Context?</span></a>
30
- <a href="_internal_.TlsOptions.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>
31
- <a href="_internal_.TlsOptions.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>
32
- <a href="_internal_.TlsOptions.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>
33
- <a href="_internal_.TlsOptions.html#sessionTimeout" 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>session<wbr/>Timeout?</span></a>
34
- <a href="_internal_.TlsOptions.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>
35
- <a href="_internal_.TlsOptions.html#ticketKeys" 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>ticket<wbr/>Keys?</span></a>
36
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_internal_.TlsOptions.html#pskCallback" 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>psk<wbr/>Callback?</span></a>
37
- </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.
38
- One argument will be passed to the callback: an object containing <code>servername</code> and <code>protocols</code> fields,
39
- respectively containing the server name from the SNI extension (if any) and an array of
40
- ALPN protocol name strings. The callback must return either one of the strings listed in <code>protocols</code>,
41
- which will be returned to the client as the selected ALPN protocol, or <code>undefined</code>,
42
- to reject the connection with a fatal alert. If a string is returned that does not match one of
43
- the client&#39;s ALPN protocols, an error will be thrown.
44
- This option cannot be used with the <code>ALPNProtocols</code> option, and setting both options will throw an error.</p>
45
- </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-inherited tsd-is-external"><a id="ALPNProtocols" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ALPNProtocols</span><a href="#ALPNProtocols" 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">ALPNProtocols</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</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><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array of strings or a Buffer naming possible ALPN protocols.
46
- (Protocols should be ordered by their priority.)</p>
47
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#ALPNProtocols">ALPNProtocols</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:526</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="SNICallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>SNICallback</span><a href="#SNICallback" 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">SNICallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">servername</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>SNICallback(servername, cb) <Function> A function that will be
48
- called if the client supports SNI TLS extension. Two arguments
49
- will be passed when called: servername and cb. SNICallback should
50
- invoke cb(null, ctx), where ctx is a SecureContext instance.
51
- (tls.createSecureContext(...) can be used to get a proper
52
- SecureContext.) If SNICallback wasn&#39;t provided the default callback
53
- with high-level API will be used (see below).</p>
54
- </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="SNICallback.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">servername</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">servername</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">ctx</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-is-external"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span>, <span class="tsd-kind-parameter">ctx</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="_internal_.Error.html" class="tsd-signature-type tsd-kind-interface">Error</a></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">ctx</span>: <a href="_internal_.SecureContext.html" class="tsd-signature-type tsd-kind-interface">SecureContext</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#SNICallback">SNICallback</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:536</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowHalfOpen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>allow<wbr/>Half<wbr/>Open</span><a href="#allowHalfOpen" 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">allow<wbr/>Half<wbr/>Open</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether half-opened TCP connections are allowed.</p>
55
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
56
- </code><button>Copy</button></pre>
57
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ServerOpts.html">ServerOpts</a>.<a href="_internal_.ServerOpts.html#allowHalfOpen">allowHalfOpen</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:510</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
58
- the well-known CAs curated by Mozilla. Mozilla&#39;s CAs are completely
59
- replaced when CAs are explicitly specified using this option.</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#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
61
- private key. Each cert chain should consist of the PEM formatted
62
- certificate for a provided private key, followed by the PEM
63
- formatted intermediate certificates (if any), in order, and not
64
- including the root CA (the root CA must be pre-known to the peer,
65
- see ca). When providing multiple cert chains, they do not have to
66
- be in the same order as their private keys in key. If the
67
- intermediate certificates are not provided, the peer will not be
68
- able to validate the certificate, and the handshake will fail.</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#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
70
- information, see modifying the default cipher suite. Permitted
71
- ciphers can be obtained via tls.getCiphers(). Cipher names must be
72
- uppercased in order for OpenSSL to accept them.</p>
73
- </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>
74
- </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>
75
- </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.
76
- If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
77
- ECDHE-based perfect forward secrecy will still be available.</p>
78
- </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
79
- NIDs or names, for example P-521:P-384:P-256, to use for ECDH key
80
- agreement. Set to auto to select the curve automatically. Use
81
- crypto.getCurves() to obtain a list of available curve names. On
82
- recent releases, openssl ecparam -list_curves will also display the
83
- name and description of each available elliptic curve. Default:
84
- tls.DEFAULT_ECDH_CURVE.</p>
85
- </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-inherited tsd-is-external"><a id="enableTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>enable<wbr/>Trace</span><a href="#enableTrace" 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">enable<wbr/>Trace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>When enabled, TLS packet trace information is written to <code>stderr</code>. This can be
86
- used to debug TLS connection problems.</p>
87
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
88
- </code><button>Copy</button></pre>
89
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#enableTrace">enableTrace</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:515</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><div class="tsd-comment tsd-typography"><p>Abort the connection if the SSL/TLS handshake does not finish in the
90
- specified number of milliseconds. A &#39;tlsClientError&#39; is emitted on
91
- the tls.Server object whenever a handshake times out. Default:
92
- 120000 (120 seconds).</p>
93
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:552</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
94
- client&#39;s. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be
95
- set in secureOptions</p>
96
- </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-inherited tsd-is-external"><a id="keepAlive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>keep<wbr/>Alive</span><a href="#keepAlive" 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">keep<wbr/>Alive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set to <code>true</code>, it enables keep-alive functionality on the socket immediately after a new incoming connection is received,
97
- similarly on what is done in <code>socket.setKeepAlive([enable][, initialDelay])</code>.</p>
98
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
99
- </code><button>Copy</button></pre>
100
- <h4>Since</h4><p>v16.5.0</p>
101
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ServerOpts.html">ServerOpts</a>.<a href="_internal_.ServerOpts.html#keepAlive">keepAlive</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:528</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keepAliveInitialDelay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>keep<wbr/>Alive<wbr/>Initial<wbr/>Delay</span><a href="#keepAliveInitialDelay" 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">keep<wbr/>Alive<wbr/>Initial<wbr/>Delay</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.</p>
102
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-9">0</span>
103
- </code><button>Copy</button></pre>
104
- <h4>Since</h4><p>v16.5.0</p>
105
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ServerOpts.html">ServerOpts</a>.<a href="_internal_.ServerOpts.html#keepAliveInitialDelay">keepAliveInitialDelay</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:534</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
106
- being encrypted. Encrypted keys will be decrypted with
107
- options.passphrase. Multiple keys using different algorithms can be
108
- provided either as an array of unencrypted key strings or buffers,
109
- or an array of objects in the form {pem: &lt;string|buffer&gt;[,
110
- passphrase: <string>]}. The object form can only occur in an array.
111
- object.passphrase is optional. Encrypted keys will be decrypted with
112
- object.passphrase if provided, or options.passphrase if it is not.</p>
113
- </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-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
114
- 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
115
- <code>secureProtocol</code> option, use one or the other.
116
- <strong>Default:</strong> <code>&#39;TLSv1.3&#39;</code>, unless changed using CLI options. Using
117
- <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
118
- <code>&#39;TLSv1.3&#39;</code>. If multiple of the options are provided, the highest maximum is used.</p>
119
- </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
120
- 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
121
- <code>secureProtocol</code> option, use one or the other. It is not recommended to use
122
- less than TLSv1.2, but it may be required for interoperability.
123
- <strong>Default:</strong> <code>&#39;TLSv1.2&#39;</code>, unless changed using CLI options. Using
124
- <code>--tls-v1.0</code> sets the default to <code>&#39;TLSv1&#39;</code>. Using <code>--tls-v1.1</code> sets the default to
125
- <code>&#39;TLSv1.1&#39;</code>. Using <code>--tls-min-v1.3</code> sets the default to
126
- &#39;TLSv1.3&#39;. If multiple of the options are provided, the lowest minimum is used.</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#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-inherited tsd-is-external"><a id="noDelay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>no<wbr/>Delay</span><a href="#noDelay" 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">no<wbr/>Delay</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If set to <code>true</code>, it disables the use of Nagle&#39;s algorithm immediately after a new incoming connection is received.</p>
128
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
129
- </code><button>Copy</button></pre>
130
- <h4>Since</h4><p>v16.5.0</p>
131
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ServerOpts.html">ServerOpts</a>.<a href="_internal_.ServerOpts.html#noDelay">noDelay</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:521</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>
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#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-inherited tsd-is-external"><a id="pauseOnConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>pause<wbr/>On<wbr/>Connect</span><a href="#pauseOnConnect" 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">pause<wbr/>On<wbr/>Connect</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the socket should be paused on incoming connections.</p>
133
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
134
- </code><button>Copy</button></pre>
135
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.ServerOpts.html">ServerOpts</a>.<a href="_internal_.ServerOpts.html#pauseOnConnect">pauseOnConnect</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:515</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
136
- alternative to providing key and cert individually. PFX is usually
137
- encrypted, if it is, passphrase will be used to decrypt it. Multiple
138
- PFX can be provided either as an array of unencrypted PFX buffers,
139
- or an array of objects in the form {buf: &lt;string|buffer&gt;[,
140
- passphrase: <string>]}. The object form can only occur in an array.
141
- object.passphrase is optional. Encrypted PFX will be decrypted with
142
- object.passphrase if provided, or options.passphrase if it is not.</p>
143
- </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
144
- together with privateKeyIdentifier.</p>
145
- </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
146
- used together with privateKeyEngine. Should not be set together with
147
- key, because both options define a private key in different ways.</p>
148
- </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="pskIdentityHint" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>psk<wbr/>Identity<wbr/>Hint</span><a href="#pskIdentityHint" 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">psk<wbr/>Identity<wbr/>Hint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>hint to send to a client to help
149
- with selecting the identity during TLS-PSK negotiation. Will be ignored
150
- in TLS 1.3. Upon failing to set pskIdentityHint <code>tlsClientError</code> will be
151
- emitted with <code>ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED</code> code.</p>
152
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:588</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited 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><div class="tsd-comment tsd-typography"><p>If true the server will reject any connection which is not
153
- authorized with the list of supplied CAs. This option only has an
154
- effect if requestCert is true.</p>
155
- </div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
156
- </code><button>Copy</button></pre>
157
- </div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#rejectUnauthorized">rejectUnauthorized</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:543</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="requestCert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>request<wbr/>Cert</span><a href="#requestCert" 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">request<wbr/>Cert</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true the server will request a certificate from clients that
158
- connect and attempt to verify that certificate. Defaults to
159
- false.</p>
160
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#requestCert">requestCert</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:521</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="secureContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>secure<wbr/>Context</span><a href="#secureContext" 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/>Context</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.SecureContext.html" class="tsd-signature-type tsd-kind-interface">SecureContext</a></div><div class="tsd-comment tsd-typography"><p>An optional TLS context object from tls.createSecureContext()</p>
161
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a>.<a href="_internal_.CommonConnectionOptions.html#secureContext">secureContext</a></p><ul><li>Defined in node_modules/@types/node/tls.d.ts:509</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
162
- usually necessary. This should be used carefully if at all! Value is
163
- a numeric bitmask of the SSL_OP_* options from OpenSSL Options</p>
164
- </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
165
- not support independent control of the minimum and maximum version,
166
- and does not support limiting the protocol to TLSv1.3. Use
167
- minVersion and maxVersion instead. The possible values are listed as
168
- SSL_METHODS, use the function names as strings. For example, use
169
- &#39;TLSv1_1_method&#39; to force TLS version 1.1, or &#39;TLS_method&#39; to allow
170
- any TLS protocol version up to TLSv1.3. It is not recommended to use
171
- TLS versions less than 1.2, but it may be required for
172
- interoperability. Default: none, see minVersion.</p>
173
- </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
174
- shared between applications. Unused by clients.</p>
175
- </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-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
176
- server will no longer be resumable. See Session Resumption for more
177
- information. Default: 300.</p>
178
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <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:558</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
179
- can contain digest algorithms (SHA256, MD5 etc.), public key
180
- algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g
181
- &#39;RSA+SHA384&#39;) or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).</p>
182
- </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="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.</p>
183
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <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:562</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="pskCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>psk<wbr/>Callback</span><a href="#pskCallback" 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="pskCallback.pskCallback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">psk<wbr/>Callback</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">socket</span>, <span class="tsd-kind-parameter">identity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DataView</span><span class="tsd-signature-symbol"> | </span><a href="../types/_internal_.TypedArray.html" class="tsd-signature-type tsd-kind-type-alias">TypedArray</a><a href="#pskCallback.pskCallback-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">socket</span>: <a href="../classes/_internal_.TLSSocket.html" class="tsd-signature-type tsd-kind-class">TLSSocket</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">identity</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>identity parameter sent from the client.</p>
184
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DataView</span><span class="tsd-signature-symbol"> | </span><a href="../types/_internal_.TypedArray.html" class="tsd-signature-type tsd-kind-type-alias">TypedArray</a></h4><p>pre-shared key that must either be
185
- a buffer or <code>null</code> to stop the negotiation process. Returned PSK must be
186
- compatible with the selected cipher&#39;s digest.</p>
187
- <p>When negotiating TLS-PSK (pre-shared keys), this function is called
188
- with the identity provided by the client.
189
- If the return value is <code>null</code> the negotiation process will stop and an
190
- &quot;unknown_psk_identity&quot; alert message will be sent to the other party.
191
- If the server wishes to hide the fact that the PSK identity was not known,
192
- the callback must provide some random data as <code>psk</code> to make the connection
193
- fail with &quot;decrypt_error&quot; before negotiation is finished.
194
- PSK ciphers are disabled by default, and using TLS-PSK thus
195
- requires explicitly specifying a cipher suite with the <code>ciphers</code> option.
196
- More information can be found in the RFC 4279.</p>
197
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:581</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="#ALPNProtocols" 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>ALPNProtocols</span></a><a href="#SNICallback" 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>SNICallback</span></a><a href="#allowHalfOpen" 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>allow<wbr/>Half<wbr/>Open</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="#enableTrace" 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>enable<wbr/>Trace</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="#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="#keepAlive" 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>keep<wbr/>Alive</span></a><a href="#keepAliveInitialDelay" 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>keep<wbr/>Alive<wbr/>Initial<wbr/>Delay</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="#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="#noDelay" 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>no<wbr/>Delay</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="#pauseOnConnect" 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>pause<wbr/>On<wbr/>Connect</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="#pskIdentityHint" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>psk<wbr/>Identity<wbr/>Hint</span></a><a href="#rejectUnauthorized" 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>reject<wbr/>Unauthorized</span></a><a href="#requestCert" 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>request<wbr/>Cert</span></a><a href="#secureContext" 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/>Context</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-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="#ticketKeys" class="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="#pskCallback" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>psk<wbr/>Callback</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_.UnderlyingByteSource.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>UnderlyingByteSource | @codebolt/codeboltjs</title><meta name="description" content="Documentation for @codebolt/codeboltjs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@codebolt/codeboltjs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@codebolt/codeboltjs</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.UnderlyingByteSource.html">UnderlyingByteSource</a></li></ul><h1>Interface UnderlyingByteSource</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UnderlyingByteSource</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingByteSource.html#autoAllocateChunkSize">autoAllocateChunkSize</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_.UnderlyingByteSource.html#cancel">cancel</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.ReadableStreamErrorCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableStreamErrorCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingByteSource.html#pull">pull</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.ReadableByteStreamControllerCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableByteStreamControllerCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingByteSource.html#start">start</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.ReadableByteStreamControllerCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableByteStreamControllerCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingByteSource.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;bytes&quot;</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/node/stream/web.d.ts:122</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_.UnderlyingByteSource.html#autoAllocateChunkSize" 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>auto<wbr/>Allocate<wbr/>Chunk<wbr/>Size?</span></a>
2
- <a href="_internal_.UnderlyingByteSource.html#cancel" 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>cancel?</span></a>
3
- <a href="_internal_.UnderlyingByteSource.html#pull" 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>pull?</span></a>
4
- <a href="_internal_.UnderlyingByteSource.html#start" 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>start?</span></a>
5
- <a href="_internal_.UnderlyingByteSource.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>
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="autoAllocateChunkSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>auto<wbr/>Allocate<wbr/>Chunk<wbr/>Size</span><a href="#autoAllocateChunkSize" 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">auto<wbr/>Allocate<wbr/>Chunk<wbr/>Size</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/node/stream/web.d.ts:123</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="cancel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cancel</span><a href="#cancel" 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">cancel</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.ReadableStreamErrorCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableStreamErrorCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:124</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="pull" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>pull</span><a href="#pull" 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">pull</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.ReadableByteStreamControllerCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableByteStreamControllerCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:125</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>start</span><a href="#start" 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">start</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.ReadableByteStreamControllerCallback.html" class="tsd-signature-type tsd-kind-interface">ReadableByteStreamControllerCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:126</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">&quot;bytes&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:127</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="#autoAllocateChunkSize" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Allocate<wbr/>Chunk<wbr/>Size</span></a><a href="#cancel" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel</span></a><a href="#pull" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull</span></a><a href="#start" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start</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>
package/docs/interfaces/_internal_.UnderlyingSink.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>UnderlyingSink | @codebolt/codeboltjs</title><meta name="description" content="Documentation for @codebolt/codeboltjs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@codebolt/codeboltjs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@codebolt/codeboltjs</a></li><li><a href="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="_internal_.UnderlyingSink.html">UnderlyingSink</a></li></ul><h1>Interface UnderlyingSink&lt;W&gt;</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">UnderlyingSink</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_internal_.UnderlyingSink.html#W">W</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingSink.html#abort">abort</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.UnderlyingSinkAbortCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkAbortCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingSink.html#close">close</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.UnderlyingSinkCloseCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkCloseCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingSink.html#start">start</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.UnderlyingSinkStartCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkStartCallback</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingSink.html#type">type</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_internal_.UnderlyingSink.html#write">write</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.UnderlyingSinkWriteCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkWriteCallback</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_internal_.UnderlyingSink.html#W">W</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="W" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">W</span> = <span class="tsd-signature-type">any</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:135</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_.UnderlyingSink.html#abort" 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>abort?</span></a>
2
- <a href="_internal_.UnderlyingSink.html#close" 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>close?</span></a>
3
- <a href="_internal_.UnderlyingSink.html#start" 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>start?</span></a>
4
- <a href="_internal_.UnderlyingSink.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_.UnderlyingSink.html#write" 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>write?</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="abort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>abort</span><a href="#abort" 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">abort</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.UnderlyingSinkAbortCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkAbortCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:136</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>close</span><a href="#close" 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">close</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.UnderlyingSinkCloseCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkCloseCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:137</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>start</span><a href="#start" 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">start</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.UnderlyingSinkStartCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkStartCallback</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:138</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"><code class="tsd-tag ts-flagOptional">Optional</code> <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">undefined</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:139</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="write" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>write</span><a href="#write" 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">write</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.UnderlyingSinkWriteCallback.html" class="tsd-signature-type tsd-kind-interface">UnderlyingSinkWriteCallback</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_internal_.UnderlyingSink.html#W">W</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/stream/web.d.ts:140</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="#abort" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>abort</span></a><a href="#close" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close</span></a><a href="#start" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start</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="#write" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>write</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>