jose/docs/functions/_util_generate_secret_.generatesecret.md
2020-12-14 16:43:16 +01:00

842 B

Function: generateSecret

generateSecret(alg: string): Promise<KeyLike>

Defined in src/util/generate_secret.ts:28

Generates a symmetric secret key for a given JWA algorithm identifier.

example

// ESM import
import generateSecret from 'jose/util/generate_secret'

example

// CJS import
const { default: generateSecret } = require('jose/util/generate_secret')

example

// usage
const secret = await generateSecret('HS256')
console.log(secret)

Parameters:

Name Type Description
alg string JWA Algorithm Identifier to be used with the generated secret.

Returns: Promise<KeyLike>