Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 987 Bytes

key_generate_secret.generateSecret.md

File metadata and controls

34 lines (22 loc) · 987 Bytes

Function: generateSecret

💗 Help the project

generateSecret<T>(alg, options?): Promise<T | Uint8Array>

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

Note: Under Web Crypto API runtime the secret key is generated with extractable set to false by default.

example Usage

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

Type parameters

Name Type
T extends KeyLike = KeyLike

Parameters

Name Type Description
alg string JWA Algorithm Identifier to be used with the generated secret.
options? GenerateSecretOptions Additional options passed down to the secret generation.

Returns

Promise<T | Uint8Array>