push.rocks/smartsocket
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Philipp Kunz 2018-03-17 17:52:01 +01:00
parent cde8270313
commit eaa97f0598
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -38,6 +38,11 @@ let mySmartsocket = new smartsocket.Smartsocket({
port: 3000 // the port smartsocket will listen on port: 3000 // the port smartsocket will listen on
}); });
// optional:
// run this with anothoer existing server like express
declare var someExpressServer // read the express docs about how express actually works
mySmartsocket.setServer(someExpressServer)
// A "SocketRole" can be referenced by "SocketFunction"s. // A "SocketRole" can be referenced by "SocketFunction"s.
// All "SocketRequest"s carry authentication data for a specific "SocketRole". // All "SocketRequest"s carry authentication data for a specific "SocketRole".
// "SocketFunction"s know which "SocketRole"s are allowed to execute them // "SocketFunction"s know which "SocketRole"s are allowed to execute them

1
ts/smartsocket.classes.smartsocket.ts
View File

@ -47,6 +47,7 @@ export class Smartsocket {
/** /**
* starts the server with another server * starts the server with another server
* also works with an express style server
*/ */
async setServer(httpServerArg: http.Server) { async setServer(httpServerArg: http.Server) {
this.httpServer = httpServerArg; this.httpServer = httpServerArg;