next-auth/jwt/index.d.ts

Authentication for Next.js

import type { NextApiRequest } from "next";
import type { JWT, JWTDecodeParams, JWTEncodeParams } from "./types";
import type { LoggerInstance } from "..";
export * from "./types";
/** Issues a JWT. By default, the JWT is encrypted using "A256GCM". */
export declare function encode({ token, secret, maxAge, }: JWTEncodeParams): Promise<string>;
/** Decodes a NextAuth.js issued JWT. */
export declare function decode({ token, secret, }: JWTDecodeParams): Promise<JWT | null>;
export interface GetTokenParams<R extends boolean = false> {
    /** The request containing the JWT either in the cookies or in the `Authorization` header. */
    req: NextApiRequest;
    /**
     * Use secure prefix for cookie name, unless URL in `NEXTAUTH_URL` is http://
     * or not set (e.g. development or test instance) case use unprefixed name
     */
    secureCookie?: boolean;
    /** If the JWT is in the cookie, what name `getToken()` should look for. */
    cookieName?: string;
    /**
     * `getToken()` will return the raw JWT if this is set to `true`
     * @default false
     */
    raw?: R;
    secret: string;
    decode?: typeof decode;
    logger?: LoggerInstance | Console;
}
/**
 * Takes a NextAuth.js request (`req`) and returns either the NextAuth.js issued JWT's payload,
 * or the raw JWT string. We look for the JWT in the either the cookies, or the `Authorization` header.
 * [Documentation](https://next-auth.js.org/tutorials/securing-pages-and-api-routes#using-gettoken)
 */
export declare function getToken<R extends boolean = false>(params?: GetTokenParams<R>): Promise<R extends true ? string : JWT | null>;