Type Alias ExpressSessionKit<TPayload, TPrincipal>

ExpressSessionKit: {
    core: SessionKit<TPayload, TPrincipal>;
    context(
        req: SessionKitExpressRequest,
        res: SessionKitExpressResponse,
    ): HttpContext;
    middleware(
        options?: SessionKitExpressAdapterOptions,
    ): SessionKitExpressHandler;
    optionalAuth(
        options?: SessionKitExpressAdapterOptions,
    ): SessionKitExpressHandler;
    requireAuth(
        requireAuthOptions?: RequireAuthOptions,
        options?: SessionKitExpressAdapterOptions,
    ): SessionKitExpressHandler;
    signIn(
        req: SessionKitExpressRequest,
        res: SessionKitExpressResponse,
        payload: TPayload,
        options?: SignInOptions,
    ): Promise<SignInResult<TPrincipal>>;
    signOut(
        req: SessionKitExpressRequest,
        res: SessionKitExpressResponse,
        options?: SignOutOptions,
    ): Promise<void>;
    getAuth(
        req: SessionKitExpressRequest,
        res: SessionKitExpressResponse,
    ): AuthContext<TPayload, TPrincipal>;
}

Adapter-bound SessionKit facade for Express applications.

Type Parameters

  • TPayload
  • TPrincipal

Type declaration

Settings

Member Visibility