express-jwtoken/dist/lib/clientTokenEngine/clientTokenEngine.d.ts

Simple express JSON Web Token library.

/// <reference types="express-serve-static-core" />
import JwtToken from "./../main/jwtToken";
/**
 * Engine component to set, get or remove the token from the client.
 */
export default interface ClientTokenEngine {
    /**
     * Function to get the signed token from the client by using the request object.
     * The method can return the signed token as a string, or null if there is no signed token.
     * @param req
     */
    getToken: (req: Express.Request) => Promise<string | null> | string | null;
    /**
     * Function to set the token to the client.
     * Will be used by the authenticate method on the response object.
     * @param signToken
     * @param plainToken
     * @param res
     */
    setToken: (signToken: string, plainToken: JwtToken, res: Express.Response) => Promise<void> | void;
    /**
     * Function to tell the client to remove the token.
     * Will be used in the case that the provided token is not valid or
     * by calling the deauthenticate method on the response object.
     * @param signToken
     * @param res
     */
    removeToken: (res: Express.Response) => Promise<void> | void;
}