Class OtpService<SendArgs>

Type Parameters

SendArgs extends AnySendArgs = AnySendArgs

Hierarchy

OtpService

Index

Constructors

constructor

new OtpService<SendArgs>(__namedParameters): OtpService<SendArgs>
Type Parameters
- SendArgs extends AnySendArgs = AnySendArgs
Parameters
- __namedParameters: OtpConfig<SendArgs>
Returns OtpService<SendArgs>
- Defined in src/OtpService.ts:27

Properties

`Private` `Optional` _sendOtp

_sendOtp?: SendOtpFn<SendArgs>

`Private` generateId

generateId: (() => string)

Type declaration

- (): string
- Returns string

`Private` generateSolution

generateSolution: (() => string)

Type declaration

- (): string
- Returns string

`Private` gracePeriod

gracePeriod: number

`Private` hash

hash: ((value) => string)

Type declaration

- (value): string
- Parameters
  - value: string
  Returns string

`Private` maxAttempts

maxAttempts: number

`Private` storage

storage: OtpStorage

`Private` storagePrefix

storagePrefix: string

`Private` storageTtl

storageTtl: number

`Private` timeToResend

timeToResend: number

`Private` timeToSolve

timeToSolve: number

Methods

`Private` calculateResendableAt

calculateResendableAt(expiresAt): number
Parameters
- expiresAt: number
Returns number
- Defined in src/OtpService.ts:73

check

check<Data>(token, solution, extra?): Promise<OtpResult<Data>>
Check the solution of the token. Default behavior is to invalidate the token when it is solved correctly.

Last option allowReuseOfSolvedToken allows to mark the token as solved instead of invalidating it, so that it can be checked inside another API route with getTokenInformation function. If this option is used, the developer is responsible to invalidating the token after use.

Usefull when solved token will be sent to another endpoint. It is the only way to keep logic not pretaining to otp solving outside of otp endpoints, Otherwise everything goes through otp handlers and it gets messy very quickly. Simply send solved token to an API endpoint, and

allowReuseOfSolvedToken should be set to true if validation of multiple tokens is required. For example, when phone and email needs to be validated before registration. While multiple otps are solved, we want to keep them existing in the cache before proceeding to registration
Type Parameters
- Data = unknown
Parameters
- token: string
- solution: string
- Optional extra: {
  allowReuseOfSolvedToken?: boolean;
  }
  - Optional allowReuseOfSolvedToken?: boolean
Returns Promise<OtpResult<Data>>
Throws
- Defined in src/OtpService.ts:129

`Private` getSolution

getSolution(token): Promise<string>
Parameters
- token: string
Returns Promise<string>
- Defined in src/OtpService.ts:315

getTokenInformation

getTokenInformation<Data>(token): Promise<OtpResult<Data>>
Recieves the current status of the token only if it exists, otherwise it throws
Type Parameters
- Data = unknown
Parameters
- token: string
Returns Promise<OtpResult<Data>>
Throws
- Defined in src/OtpService.ts:83

invalidateToken

invalidateToken(token): Promise<void>
Invalidate a token. Important to call this function when allowReuseOfSolvedToken is enabled when solution is checked
Parameters
- token: string
Returns Promise<void>
Throws
- Defined in src/OtpService.ts:286

issue

issue<Data>(account, sendArgs, customData?): Promise<OtpResult<Data>>
Issues a new token
Type Parameters
- Data = unknown
Parameters
- account: string
- sendArgs: SendArgs
  arguments passed to sendOtp
- Optional customData: Data
  any JSON-encodable data can be embedded into the token
Returns Promise<OtpResult<Data>>
Throws
- Defined in src/OtpService.ts:221

resend

resend<Data>(token, sendArgs): Promise<OtpResult<Data>>
Resends otp message and issues a new token
Type Parameters
- Data = unknown
Parameters
- token: string
- sendArgs: SendArgs
  arguments passed to sendOtp
Returns Promise<OtpResult<Data>>
Throws
- Defined in src/OtpService.ts:260

`Private` sendOtp

sendOtp(account, solution, args): Promise<void>
Parameters
- account: string
- solution: string
- args: SendArgs
Returns Promise<void>
- Defined in src/OtpService.ts:296

`Private` setSolution

setSolution(token, value): Promise<void>
Parameters
- token: string
- value: string
Returns Promise<void>
- Defined in src/OtpService.ts:306

Generated using TypeDoc