Skip to main content

Function: generateOneTimeToken()

generateOneTimeToken(args?): OneTimeToken

Defined in: oneTimeToken.ts:118

Parameters

ParameterTypeDescription
args?{ bytes?: number; digits?: number; expiresInSeconds?: number; format?: OneTimeTokenFormat; }-
args.bytes?numberNumber of random bytes. The token is the hex encoding, so the string length is twice this value. Defaults to 32. Ignored when format is numeric.
args.digits?numberNumber of digits when format is numeric. Defaults to 6, and must be between MIN_NUMERIC_DIGITS and MAX_NUMERIC_DIGITS. Ignored when format is hex.
args.expiresInSeconds?numberToken lifetime in seconds. Defaults to 24 hours for hex and 10 minutes for numeric, whose smaller keyspace makes a long window a guessing window.
args.format?OneTimeTokenFormatToken encoding. Defaults to hex.

Returns

OneTimeToken