amiwo

Class: Session

Session

new Session(app:, options)

Parameters:
Name Type Description
app: String

application name
options Object
Source:

Methods

<static> getSession()

Get the Session object for an application

Source:

clearMessages()

Clear messages (and init messages if they didn't exist)

Source:

clearRequest(req)

Clear session request object

Parameters:
Name Type Description
req Request
Source:

clearResponse(req)

Clear session response object

Parameters:
Name Type Description
req Request
Source:

deleteRequest(req, property)

Delete a value from our session request object

Parameters:
Name Type Description
req Request
property String

property name, can use dot to build a structured JSON
Source:
Returns:

the deleted entry

Type
any

deleteResponse(req, property)

Delete a value from our session response object

Parameters:
Name Type Description
req Request
property String

property name, can use dot to build a structured JSON
Source:
Returns:

the deleted entry

Type
any

getMessages()

Get message objects

Source:

getRequest(req, property [, deleteEntry])

Get a value from our session request object

Parameters:
Name Type Argument Default Description
req Request
property String

property name, can use dot to build a structured JSON
deleteEntry Boolean <optional>
 true

if set to true, delete response object
Source:

getResponse(req, property [, deleteEntry])

Get a value from our session response object

Parameters:
Name Type Argument Default Description
req Request
property String

property name, can use dot to build a structured JSON
deleteEntry Boolean <optional>
 true

if set to true, delete response object
Source:

init()

Middleware to initialize our session logic

Source:

initMessages()

Create the objects to hold flash messages if needed.

Source:

setErrorMessage()

Saves an error message

Source:

setInfoMessage()

Saves an info message

Source:

setMessage()

Set a new message

Source:

setRequest(req, property, value)

Saves 'value' into our session request object

Parameters:
Name Type Description
req Request
property String

property name, can use dot to build a structured JSON
value any
Source:

setResponse(req, property, value)

Saves 'value' into our session response object

Parameters:
Name Type Description
req Request
property String

property name, can use dot to build a structured JSON
value any
Source:

setSuccessMessage()

Saves a success message

Source:

setWarningMessage()

Saves a warning message

Source: