Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.57 KB

key_generate_secret.generateSecret.md

File metadata and controls

38 lines (24 loc) · 1.57 KB

Function: generateSecret

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.


generateSecret<KeyLikeType>(alg, options?): Promise<KeyLikeType | 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.

Type parameters

Name Type
KeyLikeType 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<KeyLikeType | Uint8Array>

Example

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