Class JsonWebTokenManager<PROPS, JWT_PROPS, CREATION_ARGS, TEST_ARGS>

Manages the creation and verification of json web tokens.

Since

0.1.0

Type Parameters

PROPS extends JsonWebTokenProperty<unknown, unknown, JsonWebTokenData>[]
The properties of the token.
JWT_PROPS extends JsonWebTokenData & TokenTypeMatchingForAllProperties<PROPS> = TokenTypeMatchingForAllProperties<PROPS>
The type of the token's data.
CREATION_ARGS extends CREATION_ARGS_FOR_ALL_PROPERTIES<PROPS> = CREATION_ARGS_FOR_ALL_PROPERTIES<PROPS>
The type of the arguments needed to create the token.
TEST_ARGS extends TEST_ARGS_FOR_ALL_PROPERTIES<PROPS> = TEST_ARGS_FOR_ALL_PROPERTIES<PROPS>
The type of the arguments needed to test the token.

Hierarchy

JsonWebTokenManager

Index

Constructors

Properties

properties secret

Methods

create sign unpack verify

Constructors

constructor

new JsonWebTokenManager<PROPS, JWT_PROPS, CREATION_ARGS, TEST_ARGS>(secret, properties?): JsonWebTokenManager<PROPS, JWT_PROPS, CREATION_ARGS, TEST_ARGS>
Creates a new JsonWebTokenManager.
Type Parameters
- PROPS extends JsonWebTokenProperty<unknown, unknown, JsonWebTokenData>[]
- JWT_PROPS extends JsonWebTokenData = TokenTypeMatchingForAllProperties<PROPS>
- CREATION_ARGS extends unknown = CREATION_ARGS_FOR_ALL_PROPERTIES<PROPS>
- TEST_ARGS extends unknown = TEST_ARGS_FOR_ALL_PROPERTIES<PROPS>
Parameters
- secret: string
  The secret used to sign the token. Must be the same for all instances of the same type and must be kept secret.
- properties: PROPS = ...
  The properties of the token.
Returns JsonWebTokenManager<PROPS, JWT_PROPS, CREATION_ARGS, TEST_ARGS>
Since
0.1.0
- Defined in authorization.ts:403

Properties

`Private` `Readonly` properties

properties: PROPS = ...

The properties of the token.

`Private` `Readonly` secret

secret: string

The secret used to sign the token. Must be the same for all instances of the same type and must be kept secret.

Methods

create

create(args): string
Creates a new token.
Parameters
- args: CREATION_ARGS
  The arguments needed to create the token.
Returns string
The created and signed token.

Since
0.1.0
- Defined in authorization.ts:415

sign

sign(payload): string
Signs the token.
Parameters
- payload: JWT_PROPS
  The payload to sign.
Returns string
The signed token.

Since
0.1.1
- Defined in authorization.ts:451

unpack

unpack(token): JWT_PROPS
Unpacks the token.
Parameters
- token: string
  The token to unpack.
Returns JWT_PROPS
The token's data.

Throws
Throws an error if the token is invalid.

Since
0.1.1
- Defined in authorization.ts:471

verify

verify(token, args): JWT_PROPS
Verifies a token.
Parameters
- token: string
  The token to verify.
- args: TEST_ARGS
  The arguments needed to verify the token.
Returns JWT_PROPS
The token's data.

Throws
Throws an error if the token is invalid.

Since
0.1.0
- Defined in authorization.ts:434

Generated using TypeDoc