Class JWT

Hierarchy

Data<ObjectParser>
- JWT

Implements

JWTPayload

Indexable

[propName: string]: unknown

Index

Constructors

constructor

new JWT(payload?: JWTPayload): JWT
Creates a new JWT instance with the given payload.
Parameters
- payload: JWTPayload = {}
  The payload of the JWT.
Returns JWT
Example
```
const jwt = new JWT({ sub: "1234567890", name: "John Doe" });
console.log(jwt.subject); // "1234567890"
```
Overrides Data<ObjectParser>.constructor
- Defined in src/lib/jwt.ts:16

Properties

`Protected`parser

parser: ObjectParser

`Readonly`payload

payload: JWTPayload = {}

The payload of the JWT.

Accessors

audience

get audience(): null | string | string[]
Gets the audience (aud) claim of the JWT.

The "aud" (audience) claim identifies the recipients that the JWT is intended for. It can be a single string or an array of strings representing multiple audiences.

Returns null | string | string[]
The audience claim or null if not present.
Example
```
const jwt = new JWT({ aud: "my-audience" });
console.log(jwt.audience); // "my-audience"
```
- Defined in src/lib/jwt.ts:55
set audience(value: null | string | string[]): void
Sets the audience (aud) claim of the JWT.

The "aud" claim is used to specify the recipient(s) of the token.
Parameters
- value: null | string | string[]
  The audience claim to set.
Returns void
Example
```
const jwt = new JWT();
jwt.audience = "my-audience";
console.log(jwt.audience); // "my-audience"
```
- Defined in src/lib/jwt.ts:74

expirationTime

get expirationTime(): null | number
Gets the expiration time (exp) of the JWT.

The "exp" (expiration time) claim defines the time after which the JWT must not be accepted. It is represented as a Unix timestamp in seconds.

Returns null | number
The expiration timestamp or null if not set.
Example
```
const jwt = new JWT({ exp:Date.now() + 3600 });
console.log(jwt.expirationTime); // timestamp
```
- Defined in src/lib/jwt.ts:89
set expirationTime(value: null | number): void
Sets the expiration time (exp) of the JWT.

Specifies when the JWT will expire. After this time, the token is no longer valid.
Parameters
- value: null | number
  The expiration timestamp to set.
Returns void
Example
```
const jwt = new JWT();
jwt.expirationTime = Date.now() + 3600; // 1 hour from now
console.log(jwt.expirationTime);
```
- Defined in src/lib/jwt.ts:106

expired

get expired(): boolean
Checks if the JWT has expired.

Determines if the current time is past the expiration time (exp).

Returns boolean
True if expired, false otherwise.
Example
```
const jwt = new JWT({ exp: Date.now() - 10 });
console.log(jwt.expired); // true
```
- Defined in src/lib/jwt.ts:148

expiresAt

get expiresAt(): null | Date
Gets the expiration date as a Date object.

Converts the expiration timestamp (exp) into a Date object.

Returns null | Date
The expiration date or null if not set.
Example
```
const jwt = new JWT({ exp: Date.now() + 3600 });
console.log(jwt.expiresAt); // Date object
```
- Defined in src/lib/jwt.ts:133

expiresIn

get expiresIn(): null | number
Gets the second from now until the JWT expires.

Returns null | number
The expiration in seconds from now or null.
Example
```
const jwt = new JWT({ exp:Date.now() + 3600 });
console.log(jwt.expiresIn); // seconds from now
```
- Defined in src/lib/jwt.ts:118

id

get id(): null | string
Gets the JWT ID (jti) claim.

The "jti" (JWT ID) claim is a unique identifier for the token. It is often used to prevent replay attacks by ensuring each JWT has a unique ID.

Returns null | string
The JWT ID or null if not set.
Example
```
const jwt = new JWT({ jti: "unique-id-123" });
console.log(jwt.id); // "unique-id-123"
```
- Defined in src/lib/jwt.ts:227
set id(value: null | string): void
Sets the JWT ID (jti) claim.

Assigns a unique identifier to the token.
Parameters
- value: null | string
  The JWT ID to set.
Returns void
Example
```
const jwt = new JWT();
jwt.id = "unique-id-123";
console.log(jwt.id); // "unique-id-123"
```
- Defined in src/lib/jwt.ts:243

issuedAt

get issuedAt(): null | Date
Gets the issued-at (iat) claim of the JWT.

The "iat" (issued at) claim represents the time at which the token was issued. It is typically used to track when the JWT was created.

Returns null | Date
The issuance date or null if not set.
Example
```
const jwt = new JWT({ iat: Math.floor(Date.now() / 1000) });
console.log(jwt.issuedAt); // Date object
```
- Defined in src/lib/jwt.ts:164
set issuedAt(value: null | Date): void
Sets the issued-at (iat) claim of the JWT.

Indicates the time the JWT was created.
Parameters
- value: null | Date
  The issuance date to set.
Returns void
Example
```
const jwt = new JWT();
jwt.issuedAt = new Date();
console.log(jwt.issuedAt);
```
- Defined in src/lib/jwt.ts:180

issuer

get issuer(): null | string
Gets the issuer (iss) claim of the JWT.

The "iss" (issuer) claim identifies the entity that issued the JWT. This is typically a URL or identifier of the authentication server.

Returns null | string
The issuer or null if not set.
Example
```
const jwt = new JWT({ iss: "auth.example.com" });
console.log(jwt.issuer); // "auth.example.com"
```
- Defined in src/lib/jwt.ts:195
set issuer(value: null | string): void
Sets the issuer (iss) claim of the JWT.

Identifies the entity that issued the token.
Parameters
- value: null | string
  The issuer to set.
Returns void
Example
```
const jwt = new JWT();
jwt.issuer = "auth.example.com";
console.log(jwt.issuer); // "auth.example.com"
```
- Defined in src/lib/jwt.ts:211

notBefore

get notBefore(): null | Date
Gets the not-before (nbf) claim of the JWT.

The "nbf" (not before) claim specifies the earliest time at which the JWT is valid. The token should not be accepted before this time.

Returns null | Date
The not-before date or null if not set.
Example
```
const jwt = new JWT({ nbf: Math.floor(Date.now() / 1000) + 300 });
console.log(jwt.notBefore); // Date object
```
- Defined in src/lib/jwt.ts:258
set notBefore(value: null | Date): void
Sets the not-before (nbf) claim of the JWT.

Defines when the JWT becomes valid.
Parameters
- value: null | Date
  The not-before date to set.
Returns void
Example
```
const jwt = new JWT();
jwt.notBefore = new Date(Date.now() + 300000);
console.log(jwt.notBefore); // Date object
```
- Defined in src/lib/jwt.ts:274

subject

get subject(): null | string
Gets the subject (sub) claim of the JWT.

The "sub" (subject) claim represents the entity that the JWT is about. This is often the user ID or identifier of the authenticated entity.

Returns null | string
The subject or null if not set.
Example
```
const jwt = new JWT({ sub: "user-123" });
console.log(jwt.subject); // "user-123"
```
- Defined in src/lib/jwt.ts:289
set subject(value: null | string): void
Sets the subject (sub) claim of the JWT.

Defines the entity that the token is about.
Parameters
- value: null | string
  The subject to set.
Returns void
Example
```
const jwt = new JWT();
jwt.subject = "user-123";
console.log(jwt.subject); // "user-123"
```
- Defined in src/lib/jwt.ts:305

Methods

sign

sign(
algorithm: Algoritm,
jwks: { alg: string; id: string; private: CryptoKey }[],
): Promise<string>
Signs the JWT using the specified algorithm and key set.
Parameters
- algorithm: Algoritm
  The algorithm to use for signing.
- jwks: { alg: string; id: string; private: CryptoKey }[]
  The key set containing private keys.
Returns Promise<string>
The signed JWT as a string.
Example
```
const jwt = new JWT({ sub: "1234567890" });
const signed = await jwt.sign(JWK.Algoritm.ES256, [{ private: privateKey, alg: "RS256" }]);
console.log(signed);
```
- Defined in src/lib/jwt.ts:320

toJSON

toJSON(): Record<string, unknown>
Converts the Data object into a plain JSON representation, including all properties defined as getters in the subclass.

The toJSON method dynamically identifies getter properties in the subclass and collects their values to construct a JSON object. This is particularly useful when you want to serialize the Data object for APIs, logging, or other use cases requiring JSON format.

Returns Record<string, unknown>
A plain object representing the Data instance with all getter properties.
Example
```
class LoginData extends Data<FormParser> {
  get username() {
    return this.parser.getString("username");
  }
  get password() {
    return this.parser.getString("password");
  }
}

const loginData = new LoginData(new FormParser(formData));
console.log(JSON.stringify(loginData.toJSON()));
// Output: { "username": "johndoe", "password": "secret" }
```
Inherited from Data.toJSON
- Defined in node_modules/@edgefirst-dev/data/build/index.d.ts:76

`Static`decode

decode<M extends JWT>(this: new (payload: JWTPayload) => M, token: string): M
Decodes a JWT without verifying its signature.
Type Parameters
- M extends JWT
Parameters
- this: new (payload: JWTPayload) => M
- token: string
  The JWT to decode.
Returns M
A new instance of the decoded JWT payload.
Example
```
const decoded = JWT.decode(token);
console.log(decoded.subject);
```
- Defined in src/lib/jwt.ts:395

`Static`sign

sign(
    jwt: JWT,
    algorithm: Algoritm,
    jwks: { alg: string; id: string; private: CryptoKey }[],
): Promise<string>
Signs a JWT instance using the given algorithm and key set.
Parameters
- jwt: JWT
  The JWT instance to sign.
- algorithm: Algoritm
  The signing algorithm.
- jwks: { alg: string; id: string; private: CryptoKey }[]
  The key set containing private keys.
Returns Promise<string>
The signed JWT as a string.
Example
```
const jwt = new JWT({ sub: "1234567890" });
const signed = await JWT.sign(jwt, "RS256", [{ private: privateKey, alg: "RS256" }]);
console.log(signed);
```
- Defined in src/lib/jwt.ts:366

`Static`verify

verify<M extends JWT>(
    this: new (payload: JWTPayload) => M,
    token: string,
    jwks: { public: CryptoKey }[],
    options?: JWTVerifyOptions,
): Promise<M>
Verifies a JWT using the provided key set.
Type Parameters
- M extends JWT
Parameters
- this: new (payload: JWTPayload) => M
- token: string
  The JWT to verify.
- jwks: { public: CryptoKey }[]
  The key set containing public keys.
- Optionaloptions: JWTVerifyOptions
  Optional verification options.
Returns Promise<M>
A new instance of the verified JWT payload.
Throws
If no valid key is found for verification.
Example
```
const verified = await JWT.verify(token, [{ public: publicKey }]);
console.log(verified.subject);
```
- Defined in src/lib/jwt.ts:339

Class JWT

Hierarchy

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JWT

Example

Properties

Protectedparser

Readonlypayload

Accessors

audience

Returns null | string | string[]

Example

Parameters

Returns void

Example

expirationTime

Returns null | number

Example

Parameters

Returns void

Example

expired

Returns boolean

Example

expiresAt

Returns null | Date

Example

expiresIn

Returns null | number

Example

id

Returns null | string

Example

Parameters

Returns void

Example

issuedAt

Returns null | Date

Example

Parameters

Returns void

Example

issuer

Returns null | string

Example

Parameters

Returns void

Example

notBefore

Returns null | Date

Example

Parameters

Returns void

Example

subject

Returns null | string

Example

Parameters

Returns void

Example

Methods

sign

Parameters

Returns Promise<string>

Example

toJSON

Returns Record<string, unknown>

Example

Staticdecode

Type Parameters

Parameters

`Protected`parser

`Readonly`payload

`Static`decode

`Static`sign

`Static`verify