Session Transports

    transport.get(request): string | null

    Retrieves a session identifier from a request object.

    If present this method will automatically be invoked for each transport until a transport returns a session identifier.

    Arguments

    • request: Request

    Request object to extract a session identifier from.

    Returns the session identifier or if the transport can not find a session identifier in the request.

    transport.set(response, sid): void

    Attaches a session identifier to a response object.

    If present this method will automatically be invoked at the end of a request regardless of whether the session was modified or not.

    Arguments

    • response: Response

    to attach a session identifier to.

    Session identifier to attach to the response.

    Examples

    1. set(res) {

    transport.clear(response): void

    Attaches a payload indicating that the session has been cleared to the response object.This can be used to clear a session cookie when the session has been destroyed (e.g. during logout).

    If present this method will automatically be invoked instead of set when the req.session attribute was removed by the route handler.

    Arguments

    • response:

    Response object to remove the session identifier from.