next-auth/jwt/types.d.ts

Authentication for Next.js

/// <reference types="node" />
import { decode, encode } from ".";
export interface DefaultJWT extends Record<string, unknown> {
    name?: string | null;
    email?: string | null;
    picture?: string | null;
    sub?: string;
}
/**
 * Returned by the `jwt` callback and `getToken`, when using JWT sessions
 *
 * [`jwt` callback](https://next-auth.js.org/configuration/callbacks#jwt-callback) | [`getToken`](https://next-auth.js.org/tutorials/securing-pages-and-api-routes#using-gettoken)
 */
export interface JWT extends Record<string, unknown>, DefaultJWT {
}
export interface JWTEncodeParams {
    /** The JWT payload. */
    token?: JWT;
    /** The secret used to encode the NextAuth.js issued JWT. */
    secret: string | Buffer;
    /**
     * The maximum age of the NextAuth.js issued JWT in seconds.
     * @default 30 * 24 * 30 * 60 // 30 days
     */
    maxAge?: number;
}
export interface JWTDecodeParams {
    /** The NextAuth.js issued JWT to be decoded */
    token?: string;
    /** The secret used to decode the NextAuth.js issued JWT. */
    secret: string | Buffer;
}
export interface JWTOptions {
    /** The secret used to encode/decode the NextAuth.js issued JWT. */
    secret: string;
    /**
     * The maximum age of the NextAuth.js issued JWT in seconds.
     * @default 30 * 24 * 30 * 60 // 30 days
     */
    maxAge: number;
    /** Override this method to control the NextAuth.js issued JWT encoding. */
    encode: typeof encode;
    /** Override this method to control the NextAuth.js issued JWT decoding. */
    decode: typeof decode;
}
export declare type Secret = string | Buffer;