Class JsonWebTokenProperty<TEST_ARGS, CREATION_ARGS, JWT_PROPS>`Abstract`

Properties of a JWT

Since

0.1.0

Type Parameters

TEST_ARGS
The type of the arguments needed to test the token.
CREATION_ARGS
The type of the arguments needed to create the token.
JWT_PROPS extends JsonWebTokenData
The type of the token's data.

Hierarchy

JsonWebTokenProperty
- JsonWebTokenPropertyExpireAt
- JsonWebTokenPropertyPermissions

Index

Constructors

Methods

check transform

Constructors

constructor

new JsonWebTokenProperty<TEST_ARGS, CREATION_ARGS, JWT_PROPS>(): JsonWebTokenProperty<TEST_ARGS, CREATION_ARGS, JWT_PROPS>
Type Parameters
- TEST_ARGS
- CREATION_ARGS
- JWT_PROPS extends JsonWebTokenData
Returns JsonWebTokenProperty<TEST_ARGS, CREATION_ARGS, JWT_PROPS>
- Defined in authorization.ts:173

Methods

`Abstract` check

check(jwt, args): boolean
Checks if the token is valid.
Parameters
- jwt: JWT_PROPS
  The JWT to check.
- args: TEST_ARGS
  The arguments needed to check the token.
Returns boolean
True if the token is valid, false otherwise.

Since
0.1.0
- Defined in authorization.ts:184

`Abstract` transform

transform(jwt, args): JWT_PROPS
Transforms the token.
Parameters
- jwt: JsonWebTokenData
  The JWT to transform.
- args: CREATION_ARGS
  The arguments needed to transform the token.
Returns JWT_PROPS
The transformed token.

Since
0.1.0
- Defined in authorization.ts:195

Generated using TypeDoc