ProtocolOptions

@tsed/passport

Usage

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

See /packages/security/passport/src/interfaces/ProtocolOptions.ts.

Overview

interface ProtocolOptions<Settings = any> {
    name: string;
    useStrategy: Type<Strategy>;
    settings: Settings;
    loginOnly?: boolean;
}

name

name: string;

useStrategy

useStrategy: Type<Strategy>;

settings

settings: Settings;

loginOnly

loginOnly?: boolean;

Run the strategy only on login endpoints decorated with @Authenticate().

A route decorated with @Authorize() then accepts this protocol only through the session it established, and never runs the strategy itself. Use it for interactive login strategies (passport-local, OAuth, ...) so that credentials sent to a business route do not open a new login flow.