@nowarajs/elysia-jwt
    Preparing search index...

    Interface JWTPluginOptions<TJWTKeyName>

    Configuration options for the JWT plugin.

    const options: JWTOption = {
      name: 'auth',
      secret: process.env.JWT_SECRET || 'your-secret-key',
      exp: '1d',
      header: {
        alg: 'HS256',
        typ: 'JWT'
      },
      payload: {
        iss: 'my-api',
        aud: 'my-client'
      }
    };
    interface JWTPluginOptions<TJWTKeyName extends string = "jwt"> {
        exp?: string | number | Date;
        header?: JWSHeaderParameters;
        jwtKeyName?: TJWTKeyName;
        payload?: JWTPayload;
        secret: string;
    }

    Type Parameters

    • TJWTKeyName extends string = "jwt"

      The name to be used for accessing the JWT functionality in the Elysia context

    Index

    Properties

    exp? header? jwtKeyName? payload? secret

    Properties

    exp?: string | number | Date

    JWT expiration setting. Applies as the default expiration for tokens.

    Controls how long tokens are valid before they expire. This setting provides a good balance between security (limiting the window of opportunity for token misuse) and user experience (not requiring frequent re-authentication).

    '15m' (15 minutes)

    Set tokens to expire after 1 hour

    exp: '1h'

    Set tokens to expire at a specific date

    exp: new Date('2023-12-31')

    Set tokens to expire after 3600 seconds (1 hour)

    exp: 3600
    header?: JWSHeaderParameters

    Default JWT header parameters to include in every JWT.

    This allows you to specify additional metadata about the token.

    jwtKeyName?: TJWTKeyName

    JWT name to add in context with decorate.

    This allows you to customize how you access the JWT functionality in your route handlers. For example, if set to 'auth', you would use auth.sign() instead of the default jwt.sign().

    'jwt'
    payload?: JWTPayload

    Default payload values to include in every JWT.

    These values are merged with any additional payload provided during signing, allowing you to set standard claims that should be included in all tokens generated by your application.

    payload: {
      iss: 'my-api',           // Issuer
      aud: 'my-frontend',      // Audience
    }
    secret: string

    Secret key used to sign and verify JWTs.

    Using a string secret

    secret: 'your-very-secret-key'

    Using an environment variable (recommended for production)

    secret: process.env.JWT_SECRET

    Settings

    Member Visibility

    On This Page

    Properties