LevlServer
Defined in: core/src/server/server.ts:48
Extends
Section titled “Extends”Server
Implements
Section titled “Implements”StoreProvider
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LevlServer(
config):LevlServer
Defined in: core/src/server/server.ts:54
Parameters
Section titled “Parameters”config
Section titled “config”LevlServerConfig
Returns
Section titled “Returns”LevlServer
Overrides
Section titled “Overrides”Server.constructor
Properties
Section titled “Properties”activeConfig
Section titled “activeConfig”activeConfig:
Required<LevlServerConfig>
Defined in: core/src/server/server.ts:51
configuration
Section titled “configuration”configuration:
ServerConfiguration
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:20
Inherited from
Section titled “Inherited from”Server.configuration
documents
Section titled “documents”documents:
Record<string,SharedStore> ={}
Defined in: core/src/server/server.ts:194
hocuspocus
Section titled “hocuspocus”hocuspocus:
Hocuspocus
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:19
Inherited from
Section titled “Inherited from”Server.hocuspocus
httpServer
Section titled “httpServer”httpServer:
Server
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:17
Inherited from
Section titled “Inherited from”Server.httpServer
plugins
Section titled “plugins”plugins:
LevlPlugin<PluginDescriptor>[]
Defined in: core/src/server/server.ts:52
requestHandler()
Section titled “requestHandler()”requestHandler: (
request,response) =>Promise<void>
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:24
Parameters
Section titled “Parameters”request
Section titled “request”IncomingMessage
response
Section titled “response”ServerResponse
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”Server.requestHandler
setupHttpUpgrade()
Section titled “setupHttpUpgrade()”setupHttpUpgrade: () =>
void
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:23
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Server.setupHttpUpgrade
setupWebsocketConnection()
Section titled “setupWebsocketConnection()”setupWebsocketConnection: () =>
void
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:22
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Server.setupWebsocketConnection
webSocketServer
Section titled “webSocketServer”webSocketServer:
WebSocketServer
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:18
Inherited from
Section titled “Inherited from”Server.webSocketServer
Accessors
Section titled “Accessors”address
Section titled “address”Get Signature
Section titled “Get Signature”get address():
AddressInfo
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:26
Returns
Section titled “Returns”AddressInfo
Inherited from
Section titled “Inherited from”Server.address
httpURL
Section titled “httpURL”Get Signature
Section titled “Get Signature”get httpURL():
string
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:30
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Server.httpURL
Get Signature
Section titled “Get Signature”get port():
number
Defined in: core/src/server/server.ts:190
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get URL():
string
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:28
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Server.URL
webSocketURL
Section titled “webSocketURL”Get Signature
Section titled “Get Signature”get webSocketURL():
string
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:29
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Server.webSocketURL
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
Promise<any>
Defined in: node_modules/@hocuspocus/server/dist/packages/server/src/Server.d.ts:27
Returns
Section titled “Returns”Promise<any>
Inherited from
Section titled “Inherited from”Server.destroy
get<
T>(pluginName):LevlPlugin<T>
Defined in: core/src/server/server.ts:232
Type Parameters
Section titled “Type Parameters”T extends PluginDescriptor
Parameters
Section titled “Parameters”pluginName
Section titled “pluginName”T["name"]
Returns
Section titled “Returns”LevlPlugin<T>
listen()
Section titled “listen()”listen():
Promise<Hocuspocus>
Defined in: core/src/server/server.ts:186
Returns
Section titled “Returns”Promise<Hocuspocus>
Overrides
Section titled “Overrides”Server.listen
preloadDocument()
Section titled “preloadDocument()”preloadDocument(
storeName):Promise<DirectConnection>
Defined in: core/src/server/server.ts:218
Parameters
Section titled “Parameters”storeName
Section titled “storeName”string
Returns
Section titled “Returns”Promise<DirectConnection>
storeAllDocuments()
Section titled “storeAllDocuments()”storeAllDocuments():
void
Defined in: core/src/server/server.ts:223
Returns
Section titled “Returns”void
useObject()
Section titled “useObject()”useObject<
ObjectType>(objType,id,docOverride?):InstanceType<ObjectType>
Defined in: core/src/server/server.ts:207
Type Parameters
Section titled “Type Parameters”ObjectType
Section titled “ObjectType”ObjectType extends SharedObjectType<any, any, any>
Parameters
Section titled “Parameters”objType
Section titled “objType”ObjectType
IDOfSharedObjectType<ObjectType>
docOverride?
Section titled “docOverride?”SharedStore<any>
Returns
Section titled “Returns”InstanceType<ObjectType>
Implementation of
Section titled “Implementation of”StoreProvider.useObject
useStore()
Section titled “useStore()”useStore<
StoreType>(storeType):InstanceType<StoreType>
Defined in: core/src/server/server.ts:196
returns a new SharedStore or a cached one
Type Parameters
Section titled “Type Parameters”StoreType
Section titled “StoreType”StoreType extends SharedStoreType = SharedStoreType
Parameters
Section titled “Parameters”storeType
Section titled “storeType”StoreType
Returns
Section titled “Returns”InstanceType<StoreType>
Implementation of
Section titled “Implementation of”StoreProvider.useStore