PassportMiddleware

@tsed/passport

Usage

import { PassportMiddleware } from "@tsed/passport";

See /packages/security/passport/src/middlewares/PassportMiddleware.ts.

Overview

class PassportMiddleware {
    protocolsService: ProtocolsService;
    shouldSkip(protocol: string | string[], protocols: string[], ctx: Context): boolean;
    use(ctx: Context): Promise<void>;
}

protocolsService

protocolsService: ProtocolsService;

shouldSkip

shouldSkip(protocol: string | string[], protocols: string[], ctx: Context): boolean;

Return true when an existing login session satisfies the protocols declared on the endpoint:

• the endpoint accepts any protocol ("*"),
• the endpoint accepts the reserved "session" protocol and the request carries a persisted login session,
• or the persisted login session was established by one of the endpoint protocols.

A session established by another protocol never satisfies the endpoint: its strategies run instead.

use

use(ctx: Context): Promise<void>;