Builder
Methods Summary
| Type | Name | Summary |
|---|---|---|
Adds a header to the JWT token.. | ||
Adds the payload (claims) to the web token.. | ||
Sign the token with the given algorithm.. | ||
Adds data to the payload, which contains the claims.. | ||
Add a specific Expires At ("exp") claim to the Payload.. |
Methods Details
header(key, value)
Adds a header to the JWT token.
Parameters String key a string representing the header name String value can be a string
Returns Builder the jwt builder for method chaining
Sample
payload(payload)
Adds the payload (claims) to the web token.
Parameters Object payload a json containing the data, e.g. {'some': 'data', 'somemore': 'data2'}
Returns Builder the jwt builder for method chaining
Sample
sign(alg)
Sign the token with the given algorithm. The 'alg' claim is automatically added to the token header.
Parameters Algorithm alg the algorithm used to sign the token.
Returns String a string representing the constructed JSON Web Token.
Sample
withClaim(key, value)
Adds data to the payload, which contains the claims. Claims are statements about an entity (typically, the user) and additional data.
Parameters String key a string representing the claim name (e.g. 'iss' which stands for issuer; 'email', 'name', etc.) Object value can be a string, a boolean, a date, a number or an array
Returns Builder the jwt builder for method chaining
Sample
withExpires(expire)
Add a specific Expires At ("exp") claim to the Payload.
Parameters Date expire a date representing the expiration time of the token
Returns Builder the jwt builder for method chaining
Sample
Last updated