Skip to main content

Function: generateApiToken()

generateApiToken(args): GeneratedApiToken

Defined in: apiToken.ts:31

Parameters

ParameterTypeDescription
args{ bytes?: number; displayPrefixLength?: number; prefix: string; }-
args.bytes?numberNumber of random bytes. Defaults to 32 (64 hex characters).
args.displayPrefixLength?numberNumber of characters of the token kept as displayPrefix. Defaults to 12.
args.prefixstringApplication prefix, e.g. myapp produces tokens like myapp_<hex>.

Returns

GeneratedApiToken