JwtToken
Class for working with JSON Web Token.
note
Class should be used in backend.
Import
- ES5
- ES6
const { JwtToken } = require("js-ts-kit");
import { JwtToken } from "js-ts-kit";
Creating Tokens
Code
import { JwtToken } from "js-ts-kit";
import jwt from "jsonwebtoken";
async function main() {
const jwtToken = new JwtToken("12345", jwt);
jwtToken.create({ id: 1 });
}
Output
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWQiOjEsImlhdCI6MTUxNjIzOTAyMn0
.qbkPu51ruczq9jWaoHR6jDbyU6q06QZoSVX98zboWvg;
Decoding Tokens
Code
import { JwtToken } from "js-ts-kit";
import jwt from "jsonwebtoken";
async function main() {
const jwtToken = new JwtToken("12345", jwt);
const tokenToDecode =
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWQiOjEsImlhdCI6MTUxNjIzOTAyMn0.qbkPu51ruczq9jWaoHR6jDbyU6q06QZoSVX98zboWvg";
jwtToken.decode(tokenToDecode);
}
Output
{
"sub": "1234567890",
"id": 1,
"iat": 1516239022
}
Reference
note
Check out jwt.io if you need online tool for creating jwt token or checking jwt token's payload.
Check out jsonwebtoken npm package for more information on working with JSON Web Tokens.
Create Object / Object Properties
new JwtToken(secret, jwt)
| Name | Type | Static | Description |
|---|---|---|---|
secret | string | no | secret to use for creating and decoding JWT tokens |
jwt | no | instance from importing jsonwebtoken package |
Methods
static create(payload, options)
Parameters
| Name | Type | Default Value |
|---|---|---|
payload | object | |
options | object | {} |
Returns
- Type:
string
- Description: JsonWebToken as
string
static decode(token, options)
Parameters
| Name | Type | Default Value |
|---|---|---|
token | string | |
options | object | {} |
Returns
-
Type:
object -
Description: payload of token