Module: session

Restore previous state by session or create new session
Version:
  • 1.0.0
Author:
  • Marzavec ( https://github.com/marzavec )
Source:

Methods

(static) getSession(socket, core) → {object}

Get a new json web token for the provided socket
Parameters:
Name Type Description
socket *
core *
Source:
Returns:
Type
object

(static) init(core) → {void}

Automatically executes once after server is ready
Parameters:
Name Type Description
core Object Reference to core enviroment object
Source:
Returns:
Type
void

(static) run(env) → {void}

Executes when invoked by a remote client
Parameters:
Name Type Description
env Object Enviroment object with references to core, server, socket & payload
Source:
Returns:
Type
void

(inner) notifyFailure(server, socket) → {boolean}

Reply to target socket with session failure notice
Parameters:
Name Type Description
server *
socket *
Source:
Returns:
Type
boolean

Type Definitions

session/info

Module meta information
Type:
  • Object
Properties:
Name Type Description
name string Module command name
category string Module category name
description string Information about module
usage string Information about module usage
Source: