Class EmailTokenService

Hierarchy

EmailTokenService

Index

Constructors

Properties

_jwtEngine _unverifiedJwtTokenExpirationMinutes _verifiedJwtTokenExpirationDays

Methods

createUnverifiedEmailToken createVerifiedEmailToken isTokenValid verifyToken verifyTokenOnly verifyValidTokenForSubject getTokenAudience getTokenSubject isTokenVerified setLogLevel

Constructors

constructor

new EmailTokenService(jwtEngine: JwtEngine, unverifiedJwtTokenExpirationMinutes?: number, verifiedJwtTokenExpirationDays?: number): EmailTokenService
Parameters
- jwtEngine: JwtEngine
- unverifiedJwtTokenExpirationMinutes: number = UNVERIFIED_JWT_TOKEN_EXPIRATION_MINUTES
- verifiedJwtTokenExpirationDays: number = VERIFIED_JWT_TOKEN_EXPIRATION_DAYS
Returns EmailTokenService
- Defined in fi/hg/backend/EmailTokenService.ts:33

Properties

`Private` `Readonly` _jwtEngine

_jwtEngine: JwtEngine

`Private` `Readonly` _unverifiedJwtTokenExpirationMinutes

_unverifiedJwtTokenExpirationMinutes: number

`Private` `Readonly` _verifiedJwtTokenExpirationDays

_verifiedJwtTokenExpirationDays: number

Methods

createUnverifiedEmailToken

createUnverifiedEmailToken(email: string, alg?: Algorithm): EmailTokenDTO
Parameters
- email: string
- Optional alg: Algorithm
Returns EmailTokenDTO
- Defined in fi/hg/backend/EmailTokenService.ts:272

createVerifiedEmailToken

createVerifiedEmailToken(email: string, alg?: Algorithm): EmailTokenDTO
Parameters
- email: string
- Optional alg: Algorithm
Returns EmailTokenDTO
- Defined in fi/hg/backend/EmailTokenService.ts:296

isTokenValid

isTokenValid(token: string, alg?: Algorithm): boolean
Parameters
- token: string
- Optional alg: Algorithm
Returns boolean
- Defined in fi/hg/backend/EmailTokenService.ts:192

verifyToken

verifyToken(email: string, token: string, requireVerifiedToken: boolean, alg?: Algorithm): boolean
Parameters
- email: string
- token: string
- requireVerifiedToken: boolean
- Optional alg: Algorithm
Returns boolean
- Defined in fi/hg/backend/EmailTokenService.ts:89

verifyTokenOnly

verifyTokenOnly(token: string, requireVerifiedToken: boolean, alg?: Algorithm): boolean
Parameters
- token: string
- requireVerifiedToken: boolean
- Optional alg: Algorithm
Returns boolean
- Defined in fi/hg/backend/EmailTokenService.ts:223

verifyValidTokenForSubject

verifyValidTokenForSubject(token: string, email: string, alg?: Algorithm): boolean
Parameters
- token: string
- email: string
- Optional alg: Algorithm
Returns boolean
- Defined in fi/hg/backend/EmailTokenService.ts:150

`Static` getTokenAudience

getTokenAudience(token: string): string
Deprecated
Use JwtService.decodePayloadAudience(token) directly
Parameters
- token: string
Returns string
- Defined in fi/hg/backend/EmailTokenService.ts:47

`Static` getTokenSubject

getTokenSubject(token: string): string
Deprecated
Use JwtService.decodePayloadSubject(token) directly
Parameters
- token: string
Returns string
- Defined in fi/hg/backend/EmailTokenService.ts:60

`Static` isTokenVerified

isTokenVerified(token: string): boolean
Deprecated
Use JwtService.decodePayloadVerified(token) directly
Parameters
- token: string
Returns boolean
- Defined in fi/hg/backend/EmailTokenService.ts:73

`Static` setLogLevel

setLogLevel(level: LogLevel): void
Parameters
- level: LogLevel
Returns void
- Defined in fi/hg/backend/EmailTokenService.ts:19

Generated using TypeDoc