api/session

↓ Methods.

module:api/session

Description:

  • Session cookies support

Source:

Methods

(static) check(sig, callback)

Description:

  • Return saved signature from the cache

Source:
Parameters:
Name Type Description
sig Object
callback function

(static) clear(req)

Description:

  • Clear session cookie for the request

Source:
Parameters:
Name Type Description
req Request

(static) create(req, optionsopt)

Description:

  • Create a session cookie for the request

Source:
Parameters:
Name Type Attributes Description
req Request
options Object <optional>

(static) getCookie(req)

Description:
Source:
Parameters:
Name Type Description
req Request

(static) makeCookie(req, optionsopt) → {Object}

Description:

  • Find a closest cookie by host/domain/path, longest takes precedence, returns found cookie merged with the options

Source:
Parameters:
Name Type Attributes Description
req Request
options Object <optional>
Returns:
Type Description
Object

(static) save(sig, val, callbackopt)

Description:

  • Save given signature and value in the cache, to handle expired or revoked signatures

Source:
Parameters:
Name Type Attributes Description
sig Object
val any
callback function <optional>

(static) setCookie(req, name, value)

Description:

  • Set a cookie by name and domain, the value is always encrypted

Source:
Parameters:
Name Type Description
req Request
name string
value string | Object

(static) setup(req, callbackopt)

Description:

  • Setup session cookies or access token for automatic authentication without signing, req must be complete with all required properties after successful authorization.

Source:
Parameters:
Name Type Attributes Description
req Request
callback function <optional>