@codebolt/codeboltjs 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Readme.md +47 -0
- package/{modules → dist}/agentlib/agent.js +63 -54
- package/{modules → dist}/agentlib/usermessage.js +3 -3
- package/{index.d.ts → dist/index.d.ts} +3 -0
- package/{index.js → dist/index.js} +2 -0
- package/dist/utils/editFile.d.ts +4 -0
- package/dist/utils/editFile.js +30 -0
- package/dist/utils.d.ts +5 -0
- package/{utils.js → dist/utils.js} +4 -4
- package/package.json +17 -8
- package/.codebolt/chat.json +0 -1
- package/.codebolt/debug.json +0 -1
- package/.codebolt/projectState.json +0 -127
- package/.codebolt/tasks.json +0 -1
- package/.codeboltconfig.yaml +0 -0
- package/.github/workflows/publish-to-npm.yml +0 -20
- package/bkp/toolBox.bkp.ts +0 -1162
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -127
- package/docs/assets/icons.js +0 -15
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/main.js +0 -59
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1412
- package/docs/classes/_internal_.Agent.html +0 -318
- package/docs/classes/_internal_.AsyncResource.html +0 -44
- package/docs/classes/_internal_.Blob.html +0 -33
- package/docs/classes/_internal_.ClientRequest.html +0 -506
- package/docs/classes/_internal_.Codebolt.html +0 -315
- package/docs/classes/_internal_.CustomEventEmitter-1.html +0 -248
- package/docs/classes/_internal_.CustomEventEmitter.html +0 -248
- package/docs/classes/_internal_.Duplex.html +0 -690
- package/docs/classes/_internal_.EventEmitter-1.html +0 -254
- package/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +0 -268
- package/docs/classes/_internal_.IncomingMessage.html +0 -661
- package/docs/classes/_internal_.KeyObject.html +0 -76
- package/docs/classes/_internal_.OutgoingMessage.html +0 -491
- package/docs/classes/_internal_.Readable.html +0 -551
- package/docs/classes/_internal_.ReadableBase.html +0 -551
- package/docs/classes/_internal_.Server-1.html +0 -416
- package/docs/classes/_internal_.Server-2.html +0 -326
- package/docs/classes/_internal_.Server-3.html +0 -353
- package/docs/classes/_internal_.Server.html +0 -390
- package/docs/classes/_internal_.ServerResponse.html +0 -569
- package/docs/classes/_internal_.Socket.html +0 -791
- package/docs/classes/_internal_.Stream.html +0 -256
- package/docs/classes/_internal_.TLSSocket.html +0 -947
- package/docs/classes/_internal_.URL.html +0 -140
- package/docs/classes/_internal_.URLSearchParams.html +0 -68
- package/docs/classes/_internal_.WebSocket-1.html +0 -297
- package/docs/classes/_internal_.WebSocket.Server.html +0 -261
- package/docs/classes/_internal_.Writable.html +0 -394
- package/docs/classes/_internal_.WritableBase.html +0 -394
- package/docs/classes/_internal_.X509Certificate.html +0 -144
- package/docs/classes/_internal_.internal-1.html +0 -256
- package/docs/classes/_internal_.internal.PassThrough.html +0 -686
- package/docs/classes/_internal_.internal.Transform.html +0 -693
- package/docs/enums/_internal_.logType.html +0 -4
- package/docs/functions/_internal_.WebSocket.createWebSocketStream.html +0 -1
- package/docs/functions/_internal_._node_stream_consumers_.arrayBuffer.html +0 -1
- package/docs/functions/_internal_._node_stream_consumers_.blob.html +0 -1
- package/docs/functions/_internal_._node_stream_consumers_.buffer.html +0 -1
- package/docs/functions/_internal_._node_stream_consumers_.json.html +0 -1
- package/docs/functions/_internal_._node_stream_consumers_.text.html +0 -1
- package/docs/functions/_internal_._node_stream_promises_.finished.html +0 -1
- package/docs/functions/_internal_._node_stream_promises_.pipeline.html +0 -1
- package/docs/functions/_internal_.internal.addAbortSignal.html +0 -17
- package/docs/functions/_internal_.internal.finished-1.html +0 -20
- package/docs/functions/_internal_.internal.finished.__promisify__.html +0 -1
- package/docs/functions/_internal_.internal.getDefaultHighWaterMark.html +0 -4
- package/docs/functions/_internal_.internal.isErrored.html +0 -3
- package/docs/functions/_internal_.internal.isReadable.html +0 -3
- package/docs/functions/_internal_.internal.pipeline-1.html +0 -24
- package/docs/functions/_internal_.internal.pipeline.__promisify__.html +0 -1
- package/docs/functions/_internal_.internal.setDefaultHighWaterMark.html +0 -4
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -12
- package/docs/interfaces/_internal_.AddToAgentStateResponse.html +0 -3
- package/docs/interfaces/_internal_.AddTokenResponse.html +0 -3
- package/docs/interfaces/_internal_.AddVectorItemResponse.html +0 -3
- package/docs/interfaces/_internal_.AddressInfo.html +0 -4
- package/docs/interfaces/_internal_.AgentOptions.html +0 -35
- package/docs/interfaces/_internal_.ApplicationState.html +0 -4
- package/docs/interfaces/_internal_.ArrayBufferView.html +0 -7
- package/docs/interfaces/_internal_.ArrayLike.html +0 -2
- package/docs/interfaces/_internal_.ArrayOptions.html +0 -7
- package/docs/interfaces/_internal_.AsymmetricKeyDetails.html +0 -15
- package/docs/interfaces/_internal_.AsyncGenerator.html +0 -5
- package/docs/interfaces/_internal_.AsyncGeneratorFunction.html +0 -12
- package/docs/interfaces/_internal_.AsyncIterable.html +0 -2
- package/docs/interfaces/_internal_.AsyncIterableIterator.html +0 -5
- package/docs/interfaces/_internal_.AsyncIterator.html +0 -4
- package/docs/interfaces/_internal_.AsyncResourceOptions.html +0 -12
- package/docs/interfaces/_internal_.BlobOptions.html +0 -8
- package/docs/interfaces/_internal_.Buffer.html +0 -760
- package/docs/interfaces/_internal_.BufferConstructor.html +0 -165
- package/docs/interfaces/_internal_.Certificate.html +0 -13
- package/docs/interfaces/_internal_.ChatMessage.html +0 -3
- package/docs/interfaces/_internal_.Choice.html +0 -5
- package/docs/interfaces/_internal_.CipherNameAndProtocol.html +0 -7
- package/docs/interfaces/_internal_.ClientRequestArgs.html +0 -28
- package/docs/interfaces/_internal_.CommandError.html +0 -3
- package/docs/interfaces/_internal_.CommonConnectionOptions.html +0 -29
- package/docs/interfaces/_internal_.ConnectOpts.html +0 -5
- package/docs/interfaces/_internal_.CreateFileResponse.html +0 -6
- package/docs/interfaces/_internal_.CreateFolderResponse.html +0 -6
- package/docs/interfaces/_internal_.CryptoKey.html +0 -26
- package/docs/interfaces/_internal_.DebugAddLogResponse.html +0 -4
- package/docs/interfaces/_internal_.DeleteFileResponse.html +0 -6
- package/docs/interfaces/_internal_.DeleteFolderResponse.html +0 -6
- package/docs/interfaces/_internal_.DetailedPeerCertificate.html +0 -53
- package/docs/interfaces/_internal_.Dict.html +0 -1
- package/docs/interfaces/_internal_.Disposable.html +0 -2
- package/docs/interfaces/_internal_.DropArgument.html +0 -7
- package/docs/interfaces/_internal_.DuplexOptions.html +0 -22
- package/docs/interfaces/_internal_.EphemeralKeyInfo.html +0 -7
- package/docs/interfaces/_internal_.ErrnoException.html +0 -8
- package/docs/interfaces/_internal_.Error.html +0 -4
- package/docs/interfaces/_internal_.EventEmitter-2.html +0 -130
- package/docs/interfaces/_internal_.EventEmitter.Abortable.html +0 -3
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +0 -19
- package/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +0 -32
- package/docs/interfaces/_internal_.EventEmitterOptions.html +0 -3
- package/docs/interfaces/_internal_.ExtractTextResponse.html +0 -3
- package/docs/interfaces/_internal_.GetAgentStateResponse.html +0 -3
- package/docs/interfaces/_internal_.GetContentResponse.html +0 -3
- package/docs/interfaces/_internal_.GetMarkdownResponse.html +0 -3
- package/docs/interfaces/_internal_.GetMatcherListTreeResponse.html +0 -3
- package/docs/interfaces/_internal_.GetProjectPathResponse.html +0 -5
- package/docs/interfaces/_internal_.GetTokenResponse.html +0 -3
- package/docs/interfaces/_internal_.GetVectorResponse.html +0 -3
- package/docs/interfaces/_internal_.GoToPageResponse.html +0 -3
- package/docs/interfaces/_internal_.HtmlReceived.html +0 -3
- package/docs/interfaces/_internal_.IncomingHttpHeaders.html +0 -64
- package/docs/interfaces/_internal_.InformationEvent.html +0 -8
- package/docs/interfaces/_internal_.IpcSocketConnectOpts.html +0 -6
- package/docs/interfaces/_internal_.Iterable.html +0 -2
- package/docs/interfaces/_internal_.IterableIterator.html +0 -5
- package/docs/interfaces/_internal_.Iterator.html +0 -4
- package/docs/interfaces/_internal_.IteratorReturnResult.html +0 -3
- package/docs/interfaces/_internal_.IteratorYieldResult.html +0 -3
- package/docs/interfaces/_internal_.JsonWebKey.html +0 -14
- package/docs/interfaces/_internal_.JwkKeyExportOptions.html +0 -2
- package/docs/interfaces/_internal_.KeyAlgorithm.html +0 -2
- package/docs/interfaces/_internal_.KeyExportOptions.html +0 -5
- package/docs/interfaces/_internal_.KeyObject-1.html +0 -5
- package/docs/interfaces/_internal_.LLMResponse.html +0 -4
- package/docs/interfaces/_internal_.ListenOptions.html +0 -13
- package/docs/interfaces/_internal_.LookupAddress.html +0 -6
- package/docs/interfaces/_internal_.LookupOptions.html +0 -27
- package/docs/interfaces/_internal_.MatchProblemResponse.html +0 -3
- package/docs/interfaces/_internal_.MemoryGetResponse.html +0 -5
- package/docs/interfaces/_internal_.MemorySetResponse.html +0 -5
- package/docs/interfaces/_internal_.Message.html +0 -8
- package/docs/interfaces/_internal_.MessageContent.html +0 -3
- package/docs/interfaces/_internal_.Object.html +0 -18
- package/docs/interfaces/_internal_.OnReadOpts.html +0 -6
- package/docs/interfaces/_internal_.OpenDebugBrowserResponse.html +0 -4
- package/docs/interfaces/_internal_.OutgoingHttpHeaders.html +0 -80
- package/docs/interfaces/_internal_.PeerCertificate.html +0 -50
- package/docs/interfaces/_internal_.PromiseLike.html +0 -6
- package/docs/interfaces/_internal_.PxfObject.html +0 -5
- package/docs/interfaces/_internal_.QueryVectorItemResponse.html +0 -3
- package/docs/interfaces/_internal_.QueuingStrategy.html +0 -3
- package/docs/interfaces/_internal_.QueuingStrategySize.html +0 -1
- package/docs/interfaces/_internal_.ReadFileResponse.html +0 -7
- package/docs/interfaces/_internal_.ReadOnlyDict.html +0 -1
- package/docs/interfaces/_internal_.ReadWriteStream.html +0 -144
- package/docs/interfaces/_internal_.ReadableByteStreamController.html +0 -6
- package/docs/interfaces/_internal_.ReadableByteStreamControllerCallback.html +0 -1
- package/docs/interfaces/_internal_.ReadableOptions.html +0 -11
- package/docs/interfaces/_internal_.ReadableStream-1.html +0 -141
- package/docs/interfaces/_internal_.ReadableStream.html +0 -10
- package/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +0 -5
- package/docs/interfaces/_internal_.ReadableStreamDefaultController.html +0 -5
- package/docs/interfaces/_internal_.ReadableStreamDefaultReadDoneResult.html +0 -3
- package/docs/interfaces/_internal_.ReadableStreamDefaultReadValueResult.html +0 -3
- package/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +0 -5
- package/docs/interfaces/_internal_.ReadableStreamErrorCallback.html +0 -1
- package/docs/interfaces/_internal_.ReadableStreamGenericReader.html +0 -3
- package/docs/interfaces/_internal_.ReadableStreamReadDoneResult.html +0 -3
- package/docs/interfaces/_internal_.ReadableStreamReadValueResult.html +0 -3
- package/docs/interfaces/_internal_.ReadableWritablePair.html +0 -9
- package/docs/interfaces/_internal_.SecureContext.html +0 -2
- package/docs/interfaces/_internal_.SecureContextOptions.html +0 -121
- package/docs/interfaces/_internal_.Selection.html +0 -6
- package/docs/interfaces/_internal_.ServerOptions.html +0 -64
- package/docs/interfaces/_internal_.ServerOpts.html +0 -25
- package/docs/interfaces/_internal_.SharedArrayBuffer.html +0 -7
- package/docs/interfaces/_internal_.SharedArrayBufferConstructor.html +0 -3
- package/docs/interfaces/_internal_.SocketConstructorOpts.html +0 -6
- package/docs/interfaces/_internal_.StaticEventEmitterOptions.html +0 -15
- package/docs/interfaces/_internal_.StreamOptions.html +0 -9
- package/docs/interfaces/_internal_.StreamPipeOptions.html +0 -37
- package/docs/interfaces/_internal_.TLSSocketOptions.html +0 -160
- package/docs/interfaces/_internal_.TcpSocketConnectOpts.html +0 -19
- package/docs/interfaces/_internal_.TerminalInterruptResponse.html +0 -3
- package/docs/interfaces/_internal_.TlsOptions.html +0 -197
- package/docs/interfaces/_internal_.UnderlyingByteSource.html +0 -6
- package/docs/interfaces/_internal_.UnderlyingSink.html +0 -6
- package/docs/interfaces/_internal_.UnderlyingSinkAbortCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSinkCloseCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSinkStartCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSinkWriteCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSource.html +0 -5
- package/docs/interfaces/_internal_.UnderlyingSourceCancelCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSourcePullCallback.html +0 -1
- package/docs/interfaces/_internal_.UnderlyingSourceStartCallback.html +0 -1
- package/docs/interfaces/_internal_.UpdateFileResponse.html +0 -6
- package/docs/interfaces/_internal_.UrlResponse.html +0 -3
- package/docs/interfaces/_internal_.Usage-1.html +0 -4
- package/docs/interfaces/_internal_.Usage.html +0 -4
- package/docs/interfaces/_internal_.UserMessage.html +0 -3
- package/docs/interfaces/_internal_.UserRequest.html +0 -7
- package/docs/interfaces/_internal_.WebSocket.AddressInfo.html +0 -4
- package/docs/interfaces/_internal_.WebSocket.ClientOptions.html +0 -138
- package/docs/interfaces/_internal_.WebSocket.CloseEvent.html +0 -6
- package/docs/interfaces/_internal_.WebSocket.ErrorEvent.html +0 -5
- package/docs/interfaces/_internal_.WebSocket.Event.html +0 -3
- package/docs/interfaces/_internal_.WebSocket.EventListenerOptions.html +0 -2
- package/docs/interfaces/_internal_.WebSocket.MessageEvent.html +0 -4
- package/docs/interfaces/_internal_.WebSocket.PerMessageDeflateOptions.html +0 -9
- package/docs/interfaces/_internal_.WebSocket.ServerOptions.html +0 -14
- package/docs/interfaces/_internal_.WebSocket.WebSocket.html +0 -172
- package/docs/interfaces/_internal_.WebSocket.WebSocketServer.html +0 -144
- package/docs/interfaces/_internal_.WebSocketAlias.html +0 -172
- package/docs/interfaces/_internal_.WritableOptions.html +0 -14
- package/docs/interfaces/_internal_.WritableStream-1.html +0 -8
- package/docs/interfaces/_internal_.WritableStream.html +0 -133
- package/docs/interfaces/_internal_.WritableStreamDefaultController.html +0 -6
- package/docs/interfaces/_internal_.WritableStreamDefaultWriter.html +0 -12
- package/docs/interfaces/_internal_.X509CheckOptions.html +0 -16
- package/docs/interfaces/_internal_.ZlibOptions.html +0 -21
- package/docs/interfaces/_internal_.getMatchDetail.html +0 -3
- package/docs/interfaces/_internal_.internal.FinishedOptions.html +0 -6
- package/docs/interfaces/_internal_.internal.Pipe.html +0 -5
- package/docs/interfaces/_internal_.internal.PipelineOptions.html +0 -3
- package/docs/interfaces/_internal_.internal.TransformOptions.html +0 -24
- package/docs/modules/_internal_.EventEmitter.html +0 -6
- package/docs/modules/_internal_.WebSocket.html +0 -21
- package/docs/modules/_internal_._node_stream_consumers_.html +0 -6
- package/docs/modules/_internal_._node_stream_promises_.html +0 -3
- package/docs/modules/_internal_.html +0 -228
- package/docs/modules/_internal_.internal.finished.html +0 -2
- package/docs/modules/_internal_.internal.html +0 -36
- package/docs/modules/_internal_.internal.pipeline.html +0 -2
- package/docs/modules.html +0 -3
- package/docs/types/_internal_.AnyRest.html +0 -1
- package/docs/types/_internal_.Args.html +0 -1
- package/docs/types/_internal_.ArrayBufferLike.html +0 -1
- package/docs/types/_internal_.ArrayBufferView-1.html +0 -1
- package/docs/types/_internal_.BinaryLike.html +0 -1
- package/docs/types/_internal_.BufferEncoding.html +0 -1
- package/docs/types/_internal_.BufferLike.html +0 -1
- package/docs/types/_internal_.ComposeFnParam.html +0 -1
- package/docs/types/_internal_.DefaultEventMap.html +0 -1
- package/docs/types/_internal_.EventMap.html +0 -1
- package/docs/types/_internal_.InstanceType.html +0 -2
- package/docs/types/_internal_.IteratorResult.html +0 -1
- package/docs/types/_internal_.Key.html +0 -1
- package/docs/types/_internal_.Key2.html +0 -1
- package/docs/types/_internal_.KeyFormat.html +0 -1
- package/docs/types/_internal_.KeyObjectType.html +0 -1
- package/docs/types/_internal_.KeyType-1.html +0 -1
- package/docs/types/_internal_.KeyType.html +0 -1
- package/docs/types/_internal_.KeyUsage.html +0 -1
- package/docs/types/_internal_.Listener.html +0 -1
- package/docs/types/_internal_.LookupFunction.html +0 -1
- package/docs/types/_internal_.OutgoingHttpHeader.html +0 -1
- package/docs/types/_internal_.Partial.html +0 -2
- package/docs/types/_internal_.Pick.html +0 -2
- package/docs/types/_internal_.PropertyKey.html +0 -1
- package/docs/types/_internal_.ReadableStreamController.html +0 -1
- package/docs/types/_internal_.ReadableStreamDefaultReadResult.html +0 -1
- package/docs/types/_internal_.ReadableStreamReadResult.html +0 -1
- package/docs/types/_internal_.Record.html +0 -2
- package/docs/types/_internal_.RequestListener.html +0 -1
- package/docs/types/_internal_.SecureVersion.html +0 -1
- package/docs/types/_internal_.ServerOptions-1.html +0 -1
- package/docs/types/_internal_.SocketConnectOpts.html +0 -1
- package/docs/types/_internal_.SocketReadyState.html +0 -1
- package/docs/types/_internal_.TypedArray.html +0 -1
- package/docs/types/_internal_.WebSocket.CertMeta.html +0 -2
- package/docs/types/_internal_.WebSocket.Data.html +0 -2
- package/docs/types/_internal_.WebSocket.RawData.html +0 -2
- package/docs/types/_internal_.WebSocket.VerifyClientCallbackAsync.html +0 -4
- package/docs/types/_internal_.WebSocket.VerifyClientCallbackSync.html +0 -4
- package/docs/types/_internal_.WithImplicitCoercion.html +0 -1
- package/docs/types/_internal_.internal.PipelineCallback.html +0 -1
- package/docs/types/_internal_.internal.PipelineDestination.html +0 -1
- package/docs/types/_internal_.internal.PipelineDestinationIterableFunction.html +0 -1
- package/docs/types/_internal_.internal.PipelineDestinationPromiseFunction.html +0 -1
- package/docs/types/_internal_.internal.PipelinePromise.html +0 -1
- package/docs/types/_internal_.internal.PipelineSource.html +0 -1
- package/docs/types/_internal_.internal.PipelineSourceFunction.html +0 -1
- package/docs/types/_internal_.internal.PipelineTransform.html +0 -1
- package/docs/types/_internal_.internal.PipelineTransformSource.html +0 -1
- package/docs/types/_internal_.internal.TransformCallback.html +0 -1
- package/docs/variables/_internal_.Buffer-1.html +0 -1
- package/docs/variables/_internal_.Error-1.html +0 -1
- package/docs/variables/_internal_.Object-1.html +0 -2
- package/docs/variables/_internal_.ReadableByteStreamController-1.html +0 -1
- package/docs/variables/_internal_.ReadableStream-2.html +0 -1
- package/docs/variables/_internal_.ReadableStreamBYOBReader-1.html +0 -1
- package/docs/variables/_internal_.ReadableStreamDefaultController-1.html +0 -1
- package/docs/variables/_internal_.ReadableStreamDefaultReader-1.html +0 -1
- package/docs/variables/_internal_.SharedArrayBuffer-1.html +0 -1
- package/docs/variables/_internal_.WebSocket.WebSocket-1.html +0 -1
- package/docs/variables/_internal_.WebSocket.WebSocketServer-1.html +0 -1
- package/docs/variables/_internal_.WebSocketAlias-1.html +0 -1
- package/docs/variables/_internal_.WritableStream-2.html +0 -1
- package/docs/variables/_internal_.WritableStreamDefaultController-1.html +0 -1
- package/docs/variables/_internal_.WritableStreamDefaultWriter-1.html +0 -1
- package/docs/variables/_internal_.internal.consumers.html +0 -1
- package/docs/variables/_internal_.internal.promises.html +0 -1
- package/docs/variables/default.html +0 -1
- package/script/gen.js +0 -27
- package/src/index.ts +0 -107
- package/src/modules/agent.ts +0 -120
- package/src/modules/agentlib/agent.ts +0 -406
- package/src/modules/agentlib/systemprompt.ts +0 -55
- package/src/modules/agentlib/taskInstruction.ts +0 -105
- package/src/modules/agentlib/usermessage.ts +0 -188
- package/src/modules/browser.ts +0 -352
- package/src/modules/chat.ts +0 -229
- package/src/modules/codeparsers.ts +0 -28
- package/src/modules/codeutils.ts +0 -182
- package/src/modules/crawler.ts +0 -121
- package/src/modules/dbmemory.ts +0 -52
- package/src/modules/debug.ts +0 -68
- package/src/modules/docutils.ts +0 -18
- package/src/modules/fs.ts +0 -263
- package/src/modules/git.ts +0 -237
- package/src/modules/history.ts +0 -82
- package/src/modules/knowledge.ts +0 -5
- package/src/modules/llm.ts +0 -36
- package/src/modules/outputparsers.ts +0 -30
- package/src/modules/project.ts +0 -68
- package/src/modules/rag.ts +0 -27
- package/src/modules/search.ts +0 -32
- package/src/modules/state.ts +0 -115
- package/src/modules/task.ts +0 -73
- package/src/modules/terminal.ts +0 -113
- package/src/modules/tokenizer.ts +0 -56
- package/src/modules/toolBox.ts +0 -1384
- package/src/modules/tools.ts +0 -254
- package/src/modules/vectordb.ts +0 -102
- package/src/modules/websocket.ts +0 -97
- package/src/utils.ts +0 -5
- package/tests/chat.test.js +0 -0
- package/tests/fs.test.js +0 -89
- package/tests/index.test.js +0 -4
- package/tsconfig.json +0 -122
- package/utils.d.ts +0 -5
- package/webpack.config.js +0 -25
- /package/{modules → dist}/agentlib/agent.d.ts +0 -0
- /package/{modules → dist}/agentlib/systemprompt.d.ts +0 -0
- /package/{modules → dist}/agentlib/systemprompt.js +0 -0
- /package/{modules → dist}/agentlib/taskInstruction.d.ts +0 -0
- /package/{modules → dist}/agentlib/taskInstruction.js +0 -0
- /package/{modules → dist}/agentlib/usermessage.d.ts +0 -0
- /package/{modules → dist/modules}/agent.d.ts +0 -0
- /package/{modules → dist/modules}/agent.js +0 -0
- /package/{modules → dist/modules}/browser.d.ts +0 -0
- /package/{modules → dist/modules}/browser.js +0 -0
- /package/{modules → dist/modules}/chat.d.ts +0 -0
- /package/{modules → dist/modules}/chat.js +0 -0
- /package/{modules → dist/modules}/codeparsers.d.ts +0 -0
- /package/{modules → dist/modules}/codeparsers.js +0 -0
- /package/{modules → dist/modules}/codeutils.d.ts +0 -0
- /package/{modules → dist/modules}/codeutils.js +0 -0
- /package/{modules → dist/modules}/crawler.d.ts +0 -0
- /package/{modules → dist/modules}/crawler.js +0 -0
- /package/{modules → dist/modules}/dbmemory.d.ts +0 -0
- /package/{modules → dist/modules}/dbmemory.js +0 -0
- /package/{modules → dist/modules}/debug.d.ts +0 -0
- /package/{modules → dist/modules}/debug.js +0 -0
- /package/{modules → dist/modules}/docutils.d.ts +0 -0
- /package/{modules → dist/modules}/docutils.js +0 -0
- /package/{modules → dist/modules}/fs.d.ts +0 -0
- /package/{modules → dist/modules}/fs.js +0 -0
- /package/{modules → dist/modules}/git.d.ts +0 -0
- /package/{modules → dist/modules}/git.js +0 -0
- /package/{modules → dist/modules}/history.d.ts +0 -0
- /package/{modules → dist/modules}/history.js +0 -0
- /package/{modules → dist/modules}/knowledge.d.ts +0 -0
- /package/{modules → dist/modules}/knowledge.js +0 -0
- /package/{modules → dist/modules}/llm.d.ts +0 -0
- /package/{modules → dist/modules}/llm.js +0 -0
- /package/{modules → dist/modules}/outputparsers.d.ts +0 -0
- /package/{modules → dist/modules}/outputparsers.js +0 -0
- /package/{modules → dist/modules}/project.d.ts +0 -0
- /package/{modules → dist/modules}/project.js +0 -0
- /package/{modules → dist/modules}/rag.d.ts +0 -0
- /package/{modules → dist/modules}/rag.js +0 -0
- /package/{modules → dist/modules}/search.d.ts +0 -0
- /package/{modules → dist/modules}/search.js +0 -0
- /package/{modules → dist/modules}/state.d.ts +0 -0
- /package/{modules → dist/modules}/state.js +0 -0
- /package/{modules → dist/modules}/task.d.ts +0 -0
- /package/{modules → dist/modules}/task.js +0 -0
- /package/{modules → dist/modules}/terminal.d.ts +0 -0
- /package/{modules → dist/modules}/terminal.js +0 -0
- /package/{modules → dist/modules}/tokenizer.d.ts +0 -0
- /package/{modules → dist/modules}/tokenizer.js +0 -0
- /package/{modules → dist/modules}/toolBox.d.ts +0 -0
- /package/{modules → dist/modules}/toolBox.js +0 -0
- /package/{modules → dist/modules}/tools.d.ts +0 -0
- /package/{modules → dist/modules}/tools.js +0 -0
- /package/{modules → dist/modules}/vectordb.d.ts +0 -0
- /package/{modules → dist/modules}/vectordb.js +0 -0
- /package/{modules → dist/modules}/websocket.d.ts +0 -0
- /package/{modules → dist/modules}/websocket.js +0 -0
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Choice | @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"><internal></a></li><li><a href="_internal_.Choice.html">Choice</a></li></ul><h1>Interface Choice</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Choice</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.Choice.html#finish_reason">finish_reason</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.Choice.html#index">index</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_.Choice.html#logprobs">logprobs</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.Choice.html#message">message</a><span class="tsd-signature-symbol">: </span><a href="_internal_.MessageContent.html" class="tsd-signature-type tsd-kind-interface">MessageContent</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/chatMessage.d.ts:19</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_.Choice.html#finish_reason" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>finish_<wbr/>reason</span></a>
|
|
2
|
-
<a href="_internal_.Choice.html#index" 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>index</span></a>
|
|
3
|
-
<a href="_internal_.Choice.html#logprobs" 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>logprobs?</span></a>
|
|
4
|
-
<a href="_internal_.Choice.html#message" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
5
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="finish_reason" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>finish_<wbr/>reason</span><a href="#finish_reason" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">finish_<wbr/>reason</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/chatMessage.d.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="index" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>index</span><a href="#index" 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">index</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/@codebolt/types/types/chatMessage.d.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="logprobs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>logprobs</span><a href="#logprobs" 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">logprobs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/chatMessage.d.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <a href="_internal_.MessageContent.html" class="tsd-signature-type tsd-kind-interface">MessageContent</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/chatMessage.d.ts:21</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="#finish_reason" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>finish_<wbr/>reason</span></a><a href="#index" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index</span></a><a href="#logprobs" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logprobs</span></a><a href="#message" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a></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>
|
|
@@ -1,7 +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>CipherNameAndProtocol | @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"><internal></a></li><li><a href="_internal_.CipherNameAndProtocol.html">CipherNameAndProtocol</a></li></ul><h1>Interface CipherNameAndProtocol</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CipherNameAndProtocol</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CipherNameAndProtocol.html#name">name</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_.CipherNameAndProtocol.html#standardName">standardName</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_.CipherNameAndProtocol.html#version">version</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:140</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_.CipherNameAndProtocol.html#name" 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>name</span></a>
|
|
2
|
-
<a href="_internal_.CipherNameAndProtocol.html#standardName" 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>standard<wbr/>Name</span></a>
|
|
3
|
-
<a href="_internal_.CipherNameAndProtocol.html#version" 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>version</span></a>
|
|
4
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-external"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The cipher name.</p>
|
|
5
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:144</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="standardName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>standard<wbr/>Name</span><a href="#standardName" 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">standard<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>IETF name for the cipher suite.</p>
|
|
6
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:152</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>version</span><a href="#version" 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">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>SSL/TLS protocol version.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:148</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="#name" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#standardName" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>standard<wbr/>Name</span></a><a href="#version" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</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>
|
|
@@ -1,28 +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>ClientRequestArgs | @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"><internal></a></li><li><a href="_internal_.ClientRequestArgs.html">ClientRequestArgs</a></li></ul><h1>Interface ClientRequestArgs</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ClientRequestArgs</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#_defaultAgent">_defaultAgent</a><span class="tsd-signature-symbol">?: </span><a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#agent">agent</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#auth">auth</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><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_.ClientRequestArgs.html#createConnection">createConnection</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span>, <span class="tsd-kind-parameter">oncreate</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">null</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#defaultPort">defaultPort</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><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_.ClientRequestArgs.html#family">family</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.OutgoingHttpHeaders.html" class="tsd-signature-type tsd-kind-interface">OutgoingHttpHeaders</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#hints">hints</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_.ClientRequestArgs.html#host">host</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><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_.ClientRequestArgs.html#hostname">hostname</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><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_.ClientRequestArgs.html#insecureHTTPParser">insecureHTTPParser</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_.ClientRequestArgs.html#joinDuplicateHeaders">joinDuplicateHeaders</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_.ClientRequestArgs.html#localAddress">localAddress</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#localPort">localPort</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_.ClientRequestArgs.html#lookup">lookup</a><span class="tsd-signature-symbol">?: </span><a href="../types/_internal_.LookupFunction.html" class="tsd-signature-type tsd-kind-type-alias">LookupFunction</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#maxHeaderSize">maxHeaderSize</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_.ClientRequestArgs.html#method">method</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_.ClientRequestArgs.html#path">path</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><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_.ClientRequestArgs.html#port">port</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><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_.ClientRequestArgs.html#protocol">protocol</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><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_.ClientRequestArgs.html#setHost">setHost</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_.ClientRequestArgs.html#signal">signal</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ClientRequestArgs.html#socketPath">socketPath</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_.ClientRequestArgs.html#timeout">timeout</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_.ClientRequestArgs.html#uniqueHeaders">uniqueHeaders</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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><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/http.d.ts:197</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_.ClientRequestArgs.html#_defaultAgent" 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>_default<wbr/>Agent?</span></a>
|
|
2
|
-
<a href="_internal_.ClientRequestArgs.html#agent" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent?</span></a>
|
|
3
|
-
<a href="_internal_.ClientRequestArgs.html#auth" 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>auth?</span></a>
|
|
4
|
-
<a href="_internal_.ClientRequestArgs.html#createConnection" 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>create<wbr/>Connection?</span></a>
|
|
5
|
-
<a href="_internal_.ClientRequestArgs.html#defaultPort" 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>default<wbr/>Port?</span></a>
|
|
6
|
-
<a href="_internal_.ClientRequestArgs.html#family" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family?</span></a>
|
|
7
|
-
<a href="_internal_.ClientRequestArgs.html#headers" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers?</span></a>
|
|
8
|
-
<a href="_internal_.ClientRequestArgs.html#hints" 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>hints?</span></a>
|
|
9
|
-
<a href="_internal_.ClientRequestArgs.html#host" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host?</span></a>
|
|
10
|
-
<a href="_internal_.ClientRequestArgs.html#hostname" 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>hostname?</span></a>
|
|
11
|
-
<a href="_internal_.ClientRequestArgs.html#insecureHTTPParser" 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>insecureHTTPParser?</span></a>
|
|
12
|
-
<a href="_internal_.ClientRequestArgs.html#joinDuplicateHeaders" 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>join<wbr/>Duplicate<wbr/>Headers?</span></a>
|
|
13
|
-
<a href="_internal_.ClientRequestArgs.html#localAddress" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Address?</span></a>
|
|
14
|
-
<a href="_internal_.ClientRequestArgs.html#localPort" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Port?</span></a>
|
|
15
|
-
<a href="_internal_.ClientRequestArgs.html#lookup" 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>lookup?</span></a>
|
|
16
|
-
<a href="_internal_.ClientRequestArgs.html#maxHeaderSize" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Header<wbr/>Size?</span></a>
|
|
17
|
-
<a href="_internal_.ClientRequestArgs.html#method" 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>method?</span></a>
|
|
18
|
-
<a href="_internal_.ClientRequestArgs.html#path" 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>path?</span></a>
|
|
19
|
-
<a href="_internal_.ClientRequestArgs.html#port" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port?</span></a>
|
|
20
|
-
<a href="_internal_.ClientRequestArgs.html#protocol" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol?</span></a>
|
|
21
|
-
<a href="_internal_.ClientRequestArgs.html#setHost" 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>set<wbr/>Host?</span></a>
|
|
22
|
-
<a href="_internal_.ClientRequestArgs.html#signal" 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>signal?</span></a>
|
|
23
|
-
<a href="_internal_.ClientRequestArgs.html#socketPath" 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>socket<wbr/>Path?</span></a>
|
|
24
|
-
<a href="_internal_.ClientRequestArgs.html#timeout" 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>timeout?</span></a>
|
|
25
|
-
<a href="_internal_.ClientRequestArgs.html#uniqueHeaders" 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>unique<wbr/>Headers?</span></a>
|
|
26
|
-
</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="_defaultAgent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>_default<wbr/>Agent</span><a href="#_defaultAgent" 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">_default<wbr/>Agent</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:198</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="agent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>agent</span><a href="#agent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">agent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Agent.html" class="tsd-signature-type tsd-kind-class">Agent</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:199</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="auth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>auth</span><a href="#auth" 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">auth</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:200</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="createConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>create<wbr/>Connection</span><a href="#createConnection" 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">create<wbr/>Connection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span>, <span class="tsd-kind-parameter">oncreate</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">null</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a><span class="tsd-signature-symbol">)</span></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="createConnection.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span>, <span class="tsd-kind-parameter">oncreate</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">null</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</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">options</span>: <a href="_internal_.ClientRequestArgs.html" class="tsd-signature-type tsd-kind-interface">ClientRequestArgs</a></span></li><li><span><span class="tsd-kind-parameter">oncreate</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">socket</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></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">socket</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><span class="tsd-kind-parameter">socket</span>: <a href="../classes/_internal_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../classes/_internal_.Duplex.html" class="tsd-signature-type tsd-kind-class">Duplex</a></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:201</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="defaultPort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>default<wbr/>Port</span><a href="#defaultPort" 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">default<wbr/>Port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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/http.d.ts:207</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="family" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>family</span><a href="#family" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">family</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:208</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="headers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.OutgoingHttpHeaders.html" class="tsd-signature-type tsd-kind-interface">OutgoingHttpHeaders</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:209</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="hints" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hints</span><a href="#hints" 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">hints</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/http.d.ts:210</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="host" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>host</span><a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">host</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:211</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="hostname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>hostname</span><a href="#hostname" 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">hostname</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:212</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="insecureHTTPParser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>insecureHTTPParser</span><a href="#insecureHTTPParser" 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">insecureHTTPParser</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:213</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="joinDuplicateHeaders" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>join<wbr/>Duplicate<wbr/>Headers</span><a href="#joinDuplicateHeaders" 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">join<wbr/>Duplicate<wbr/>Headers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:230</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="localAddress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>local<wbr/>Address</span><a href="#localAddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">local<wbr/>Address</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:214</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="localPort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>local<wbr/>Port</span><a href="#localPort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">local<wbr/>Port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:215</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="lookup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>lookup</span><a href="#lookup" 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">lookup</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_internal_.LookupFunction.html" class="tsd-signature-type tsd-kind-type-alias">LookupFunction</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:216</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="maxHeaderSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Header<wbr/>Size</span><a href="#maxHeaderSize" 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/>Header<wbr/>Size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-9">16384</span>
|
|
27
|
-
</code><button>Copy</button></pre>
|
|
28
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:220</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="method" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>method</span><a href="#method" 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">method</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:221</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>path</span><a href="#path" 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">path</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:222</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/http.d.ts:223</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="protocol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>protocol</span><a href="#protocol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">protocol</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:224</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="setHost" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>set<wbr/>Host</span><a href="#setHost" 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">set<wbr/>Host</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:225</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="signal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>signal</span><a href="#signal" 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">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:226</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="socketPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>socket<wbr/>Path</span><a href="#socketPath" 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">socket<wbr/>Path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:227</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="timeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>timeout</span><a href="#timeout" 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">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:228</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="uniqueHeaders" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>unique<wbr/>Headers</span><a href="#uniqueHeaders" 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">unique<wbr/>Headers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/http.d.ts:229</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="#_defaultAgent" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_default<wbr/>Agent</span></a><a href="#agent" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent</span></a><a href="#auth" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth</span></a><a href="#createConnection" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Connection</span></a><a href="#defaultPort" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Port</span></a><a href="#family" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>family</span></a><a href="#headers" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers</span></a><a href="#hints" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hints</span></a><a href="#host" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host</span></a><a href="#hostname" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hostname</span></a><a href="#insecureHTTPParser" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>insecureHTTPParser</span></a><a href="#joinDuplicateHeaders" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>join<wbr/>Duplicate<wbr/>Headers</span></a><a href="#localAddress" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Address</span></a><a href="#localPort" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>local<wbr/>Port</span></a><a href="#lookup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lookup</span></a><a href="#maxHeaderSize" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Header<wbr/>Size</span></a><a href="#method" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>method</span></a><a href="#path" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#port" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port</span></a><a href="#protocol" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol</span></a><a href="#setHost" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Host</span></a><a href="#signal" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signal</span></a><a href="#socketPath" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>socket<wbr/>Path</span></a><a href="#timeout" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timeout</span></a><a href="#uniqueHeaders" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unique<wbr/>Headers</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>
|
|
@@ -1,3 +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>CommandError | @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"><internal></a></li><li><a href="_internal_.CommandError.html">CommandError</a></li></ul><h1>Interface CommandError</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CommandError</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CommandError.html#response">response</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_.CommandError.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"commandError"</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/@codebolt/types/types/terminal.d.ts:6</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_.CommandError.html#response" 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>response</span></a>
|
|
2
|
-
<a href="_internal_.CommandError.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>
|
|
3
|
-
</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="response" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>response</span><a href="#response" 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">response</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/terminal.d.ts:8</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">"commandError"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/terminal.d.ts:7</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="#response" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response</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>
|
|
@@ -1,29 +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>CommonConnectionOptions | @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"><internal></a></li><li><a href="_internal_.CommonConnectionOptions.html">CommonConnectionOptions</a></li></ul><h1>Interface CommonConnectionOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CommonConnectionOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CommonConnectionOptions.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_.CommonConnectionOptions.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"> => </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_.CommonConnectionOptions.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_.CommonConnectionOptions.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_.CommonConnectionOptions.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_.CommonConnectionOptions.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 class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#<internal>.CommonConnectionOptions">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">CommonConnectionOptions</span><ul class="tsd-hierarchy"><li><a href="_internal_.TlsOptions.html" class="tsd-signature-type tsd-kind-interface">TlsOptions</a></li><li><a href="_internal_.TLSSocketOptions.html" class="tsd-signature-type tsd-kind-interface">TLSSocketOptions</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:505</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_.CommonConnectionOptions.html#ALPNProtocols" 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>ALPNProtocols?</span></a>
|
|
2
|
-
<a href="_internal_.CommonConnectionOptions.html#SNICallback" 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>SNICallback?</span></a>
|
|
3
|
-
<a href="_internal_.CommonConnectionOptions.html#enableTrace" 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>enable<wbr/>Trace?</span></a>
|
|
4
|
-
<a href="_internal_.CommonConnectionOptions.html#rejectUnauthorized" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject<wbr/>Unauthorized?</span></a>
|
|
5
|
-
<a href="_internal_.CommonConnectionOptions.html#requestCert" 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>request<wbr/>Cert?</span></a>
|
|
6
|
-
<a href="_internal_.CommonConnectionOptions.html#secureContext" 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>secure<wbr/>Context?</span></a>
|
|
7
|
-
</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="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.
|
|
8
|
-
(Protocols should be ordered by their priority.)</p>
|
|
9
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:526</li></ul></aside></section><section class="tsd-panel tsd-member 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"> => </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
|
|
10
|
-
called if the client supports SNI TLS extension. Two arguments
|
|
11
|
-
will be passed when called: servername and cb. SNICallback should
|
|
12
|
-
invoke cb(null, ctx), where ctx is a SecureContext instance.
|
|
13
|
-
(tls.createSecureContext(...) can be used to get a proper
|
|
14
|
-
SecureContext.) If SNICallback wasn't provided the default callback
|
|
15
|
-
with high-level API will be used (see below).</p>
|
|
16
|
-
</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.__type-1"><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"> => </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"><ul><li>Defined in node_modules/@types/node/tls.d.ts:536</li></ul></aside></section><section class="tsd-panel tsd-member 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
|
|
17
|
-
used to debug TLS connection problems.</p>
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">false</span>
|
|
19
|
-
</code><button>Copy</button></pre>
|
|
20
|
-
</div><aside class="tsd-sources"><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="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
|
|
21
|
-
authorized with the list of supplied CAs. This option only has an
|
|
22
|
-
effect if requestCert is true.</p>
|
|
23
|
-
</div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-3">true</span>
|
|
24
|
-
</code><button>Copy</button></pre>
|
|
25
|
-
</div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:543</li></ul></aside></section><section class="tsd-panel tsd-member 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
|
|
26
|
-
connect and attempt to verify that certificate. Defaults to
|
|
27
|
-
false.</p>
|
|
28
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:521</li></ul></aside></section><section class="tsd-panel tsd-member 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>
|
|
29
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/tls.d.ts:509</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="#ALPNProtocols" class="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-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="#enableTrace" class="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="#rejectUnauthorized" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject<wbr/>Unauthorized</span></a><a href="#requestCert" class="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-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></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>
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConnectOpts | @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"><internal></a></li><li><a href="_internal_.ConnectOpts.html">ConnectOpts</a></li></ul><h1>Interface ConnectOpts</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ConnectOpts</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.ConnectOpts.html#onread">onread</a><span class="tsd-signature-symbol">?: </span><a href="_internal_.OnReadOpts.html" class="tsd-signature-type tsd-kind-interface">OnReadOpts</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>.ConnectOpts">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">ConnectOpts</span><ul class="tsd-hierarchy"><li><a href="_internal_.TcpSocketConnectOpts.html" class="tsd-signature-type tsd-kind-interface">TcpSocketConnectOpts</a></li><li><a href="_internal_.IpcSocketConnectOpts.html" class="tsd-signature-type tsd-kind-interface">IpcSocketConnectOpts</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:45</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_.ConnectOpts.html#onread" 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>onread?</span></a>
|
|
2
|
-
</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="onread" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>onread</span><a href="#onread" 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">onread</span><span class="tsd-signature-symbol">?:</span> <a href="_internal_.OnReadOpts.html" class="tsd-signature-type tsd-kind-interface">OnReadOpts</a></div><div class="tsd-comment tsd-typography"><p>If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket.
|
|
3
|
-
Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will
|
|
4
|
-
still be emitted as normal and methods like pause() and resume() will also behave as expected.</p>
|
|
5
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:51</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="#onread" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>onread</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>
|
|
@@ -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>CreateFileResponse | @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"><internal></a></li><li><a href="_internal_.CreateFileResponse.html">CreateFileResponse</a></li></ul><h1>Interface CreateFileResponse</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateFileResponse</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CreateFileResponse.html#error">error</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_.CreateFileResponse.html#fileName">fileName</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_.CreateFileResponse.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CreateFileResponse.html#success">success</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_.CreateFileResponse.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"createFileResponse"</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/@codebolt/types/types/fs.d.ts:1</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_.CreateFileResponse.html#error" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error?</span></a>
|
|
2
|
-
<a href="_internal_.CreateFileResponse.html#fileName" 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>file<wbr/>Name?</span></a>
|
|
3
|
-
<a href="_internal_.CreateFileResponse.html#message" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
4
|
-
<a href="_internal_.CreateFileResponse.html#success" 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>success</span></a>
|
|
5
|
-
<a href="_internal_.CreateFileResponse.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="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>file<wbr/>Name</span><a href="#fileName" 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">file<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:4</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="success" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>success</span><a href="#success" 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">success</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:3</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">"createFileResponse"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:2</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#error" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a><a href="#fileName" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file<wbr/>Name</span></a><a href="#message" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#success" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>success</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>
|
|
@@ -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>CreateFolderResponse | @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"><internal></a></li><li><a href="_internal_.CreateFolderResponse.html">CreateFolderResponse</a></li></ul><h1>Interface CreateFolderResponse</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CreateFolderResponse</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CreateFolderResponse.html#error">error</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_.CreateFolderResponse.html#folderName">folderName</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_.CreateFolderResponse.html#message">message</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_internal_.CreateFolderResponse.html#success">success</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_.CreateFolderResponse.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"createFolderResponse"</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/@codebolt/types/types/fs.d.ts:9</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_.CreateFolderResponse.html#error" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error?</span></a>
|
|
2
|
-
<a href="_internal_.CreateFolderResponse.html#folderName" 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>folder<wbr/>Name?</span></a>
|
|
3
|
-
<a href="_internal_.CreateFolderResponse.html#message" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a>
|
|
4
|
-
<a href="_internal_.CreateFolderResponse.html#success" 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>success</span></a>
|
|
5
|
-
<a href="_internal_.CreateFolderResponse.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="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="folderName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>folder<wbr/>Name</span><a href="#folderName" 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">folder<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:12</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><a id="success" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>success</span><a href="#success" 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">success</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:11</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">"createFolderResponse"</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@codebolt/types/types/fs.d.ts:10</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#error" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error</span></a><a href="#folderName" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>folder<wbr/>Name</span></a><a href="#message" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#success" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>success</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>
|