Preparing search index...
The search index is not available
Realtime Web Suite Server package
Realtime Web Suite Server package
RWSServer
Class RWSServer
Hierarchy
Server
RWSServer
Index
Constructors
constructor
Properties
cors
Options
options
server_
app
srv
tokens
users
cookies
http_
server
ws_
server
Methods
configureHTTPServer
configureWSServer
create
Server
Starter
disconnect
Client
get
Cors
Options
get
Options
setJWTToken
web
Server
create
Server
Instance
initialize
App
on404
process
Error
Template
Constructors
constructor
new RWSServer
(
webServer
,
expressApp
,
opts
)
:
RWSServer
Parameters
webServer
:
RWSServer
expressApp
:
Express
opts
:
IInitOpts
Returns
RWSServer
Properties
Private
cors
Options
cors
Options
:
CorsOptions
Private
options
options
:
IInitOpts
Private
server_
app
server_
app
:
Express
Private
srv
srv
:
RWSServer
Private
tokens
tokens
:
UserTokens
= {}
Private
users
users
:
JWTUsers
= {}
Static
cookies
cookies
:
{
getCookie
:
(
(
headers
,
key
)
=>
Promise
<
string
>
)
;
getCookies
:
(
(
headers
)
=>
Promise
<
CookieType
>
)
;
}
= ...
Type declaration
get
Cookie
:
(
(
headers
,
key
)
=>
Promise
<
string
>
)
(
headers
,
key
)
:
Promise
<
string
>
Parameters
headers
:
AxiosRequestHeaders
key
:
string
Returns
Promise
<
string
>
get
Cookies
:
(
(
headers
)
=>
Promise
<
CookieType
>
)
(
headers
)
:
Promise
<
CookieType
>
Parameters
headers
:
AxiosRequestHeaders
Returns
Promise
<
CookieType
>
Static
Private
http_
server
http_
server
:
RWSServerPair
Static
Private
ws_
server
ws_
server
:
RWSServerPair
Methods
configureHTTPServer
configureHTTPServer
<
PassedUser
>
(
UserConstructor
?
)
:
Promise
<
RWSServer
>
Type Parameters
PassedUser
extends
IDbUser
Parameters
UserConstructor
:
(
new
(
params
)
=>
PassedUser
)
= null
new
(
params
)
:
PassedUser
Parameters
params
:
any
Returns
PassedUser
Returns
Promise
<
RWSServer
>
configureWSServer
configureWSServer
<
PassedUser
>
(
UserConstructor
?
)
:
Promise
<
RWSServer
>
Type Parameters
PassedUser
extends
IDbUser
Parameters
UserConstructor
:
(
new
(
params
)
=>
PassedUser
)
= null
new
(
params
)
:
PassedUser
Parameters
params
:
any
Returns
PassedUser
Returns
Promise
<
RWSServer
>
create
Server
Starter
create
Server
Starter
(
port
,
injected
?
)
:
RWSServerStarter
Parameters
port
:
number
injected
:
(
(
)
=>
void
)
= ...
(
)
:
void
Returns
void
Returns
RWSServerStarter
disconnect
Client
disconnect
Client
(
clientSocket
)
:
void
Parameters
clientSocket
:
Socket
<
DefaultEventsMap
,
DefaultEventsMap
,
DefaultEventsMap
,
any
>
Returns
void
get
Cors
Options
get
Cors
Options
(
)
:
CorsOptions
Returns
CorsOptions
get
Options
get
Options
(
)
:
IInitOpts
Returns
IInitOpts
setJWTToken
setJWTToken
(
socketId
,
token
)
:
void
Parameters
socketId
:
string
token
:
string
Returns
void
web
Server
web
Server
(
)
:
RWSServer
Returns
RWSServer
Static
create
Server
Instance
create
Server
Instance
(
opts
)
:
Promise
<
[
RWSServer
,
Express
]
>
Parameters
opts
:
IInitOpts
Returns
Promise
<
[
RWSServer
,
Express
]
>
Static
initialize
App
initialize
App
<
PassedUser
>
(
opts
?
,
UserConstructor
?
)
:
Promise
<
ServerControlSet
>
Type Parameters
PassedUser
extends
IDbUser
Parameters
opts
:
IInitOpts
= _DEFAULT_SERVER_OPTS
UserConstructor
:
(
new
(
)
=>
PassedUser
)
= null
new
(
)
:
PassedUser
Returns
PassedUser
Returns
Promise
<
ServerControlSet
>
Static
on404
on404
(
req
,
res
)
:
void
Parameters
req
:
Request
<
ParamsDictionary
,
any
,
any
,
ParsedQs
,
Record
<
string
,
any
>
>
res
:
Response
<
any
,
Record
<
string
,
any
>
>
Returns
void
Static
process
Error
Template
process
Error
Template
(
error
)
:
string
Parameters
error
:
RWSError
Returns
string
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
constructor
cors
Options
options
server_
app
srv
tokens
users
cookies
http_
server
ws_
server
configureHTTPServer
configureWSServer
create
Server
Starter
disconnect
Client
get
Cors
Options
get
Options
setJWTToken
web
Server
create
Server
Instance
initialize
App
on404
process
Error
Template
src
errors
index.ts
RWSErrorCodes
tests
index.ts
RWSTestSuite
services
AWSService.ts
AWSServiceInstance
AWSService
AppConfigService.ts
AppConfigService
getAppConfig
AuthService.ts
AuthServiceInstance
AuthService
ConsoleService.ts
ConsoleServiceInstance
ConsoleService
DBService.ts
DBServiceInstance
DBService
EFSService.ts
EFSServiceInstance
EFSService
LambdaService.ts
LambdaServiceInstance
LambdaService
MD5Service.ts
MD5ServiceInstance
MD5Service
ProcessService.ts
ProcessServiceInstance
ProcessService
ServerService.ts
RWSServer
_service.ts
RWSService
S3Service.ts
S3ServiceInstance
S3Service
TraversalService.ts
TraversalServiceInstance
TraversalService
UtilsService.ts
UtilsServiceInstance
UtilsService
VectorStoreService.ts
VectorStoreServiceInstance
VectorStoreService
commands
_command.ts
RWSCommand
ICmdParams
index.ts
RWSAppCommands
controllers
_controller.ts
RWSController
IRequestParams
models
convo
ConvoLoader.ts
RWSConvo
IChainCallOutput
IConvoDebugXMLData
IEmbeddingsHandler
ISplitterParams
VectorStore.ts
RWSVectorStore
prompts
_prompt.ts
RWSPrompt
ILLMChunk
IRWSPromptJSON
IRWSPromptRequestExecutor
IRWSPromptStreamExecutor
IRWSSinglePromptRequestExecutor
ChainStreamType
types
TimeSeriesModel.ts
TimeSeriesModel
interfaces
ITimeSeries.ts
ITimeSeries
_model.ts
RWSModel
IRWSModel
sockets
_socket.ts
RWSSocket
RWSJSONMessage
interfaces
IAppConfig.ts
IAppConfig
IAuthUser.ts
IAuthUser
IContextToken.ts
IContextToken
IDbUser.ts
IDbUser
ITheSocket.ts
ITheSocket
ServerTypes.ts
RWSServerPair
RWSServerStarter
ServerControlSet
WsRoutes
routing
routes.ts
IHTTProute
IPrefixedHTTProutes
RWSHTTPRoutingEntry
index.ts
RWSTrackType
RWSannotations
init.ts
serverInit
install.ts
setupPrisma
setupRWS
Generated using
TypeDoc