function getSession
Since 0.2.0
getSession(ctx: IRequestContext): ISession

Returns the session the middleware loaded for this request.

Examples

Example 1

app.router.post('/cart', (ctx) => {
  const session = getSession(ctx);
  session.set('cartId', 'c-123');
  return ctx.response.json({ ok: true });
});

Example 2

// Reaching the session from a React Router loader (Milestone 44):
ReactRouterPlugin({
  build,
  populateLoadContext: (ctx, context) => {
    context.set(sessionContext, getSession(ctx));
  },
});

Parameters

ctx: IRequestContext

The request context

Return Type

ISession

The session for this request

Throws

Error

If SessionPlugin is not registered

SessionMiddlewareMissingError

If the session middleware did not run

Usage

import { getSession } from "session-plugin/src/index.ts";