fix sign/verify secret typing

tsndr · Jun 23, 2024 · 7468a3e · 7468a3e
1 parent 8a75c24
commit 7468a3e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -86,11 +86,11 @@ Signs a payload and returns the token.
 
 Argument                 | Type               | Status   | Default     | Description
 ------------------------ | ------------------ | -------- | ----------- | -----------
-`payload`                | `object`           | required | -           | The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
-`secret`                 | `string`           | required | -           | A string which is used to sign the payload.
-`options`                | `string`, `object` | optional | `HS256`     | Either the `algorithm` string or an object.
-`options.algorithm`      | `string`           | optional | `HS256`     | See [Available Algorithms](#available-algorithms)
-`options.keyid`          | `string`           | optional | `undefined` | The `keyid` or `kid` to be set in the header of the resulting JWT.
+`payload`                | `object`                            | required | -           | The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload.
+`secret`                 | `string`, `JsonWebKey`, `CryptoKey` | required | -           | A string which is used to sign the payload.
+`options`                | `string`, `object`                  | optional | `HS256`     | Either the `algorithm` string or an object.
+`options.algorithm`      | `string`                            | optional | `HS256`     | See [Available Algorithms](#available-algorithms)
+`options.keyid`          | `string`                            | optional | `undefined` | The `keyid` or `kid` to be set in the header of the resulting JWT.
 
 #### `return`
 Returns token as a `string`.
@@ -104,12 +104,12 @@ Verifies the integrity of the token and returns a boolean value.
 
 Argument                 | Type               | Status   | Default | Description
 ------------------------ | ------------------ | -------- | ------- | -----------
-`token`                  | `string`           | required | -       | The token string generated by `jwt.sign()`.
-`secret`                 | `string`           | required | -       | The string which was used to sign the payload.
-`options`                | `string`, `object` | optional | `HS256` | Either the `algorithm` string or an object.
-`options.algorithm`      | `string`           | optional | `HS256` | See [Available Algorithms](#available-algorithms)
-`options.clockTolerance` | `number`           | optional | `0`     | Clock tolerance in seconds, to help with slighly out of sync systems.
-`options.throwError`     | `boolean`          | optional | `false` | By default this we will only throw implementation errors, only set this to `true` if you want verification errors to be thrown as well.
+`token`                  | `string`                            | required | -       | The token string generated by `jwt.sign()`.
+`secret`                 | `string`, `JsonWebKey`, `CryptoKey` | required | -       | The string which was used to sign the payload.
+`options`                | `string`, `object`                  | optional | `HS256` | Either the `algorithm` string or an object.
+`options.algorithm`      | `string`                            | optional | `HS256` | See [Available Algorithms](#available-algorithms)
+`options.clockTolerance` | `number`                            | optional | `0`     | Clock tolerance in seconds, to help with slighly out of sync systems.
+`options.throwError`     | `boolean`                           | optional | `false` | By default this we will only throw implementation errors, only set this to `true` if you want verification errors to be thrown as well.
 
 
 #### `throws`

diff --git a/src/index.ts b/src/index.ts
@@ -143,7 +143,7 @@ const algorithms: JwtAlgorithms = {
  * @throws {Error} If there"s a validation issue.
  * @returns {Promise<string>} Returns token as a `string`.
  */
-export async function sign<Payload = {}, Header = {}>(payload: JwtPayload<Payload>, secret: string | JsonWebKey, options: JwtSignOptions<Header> | JwtAlgorithm = "HS256"): Promise<string> {
+export async function sign<Payload = {}, Header = {}>(payload: JwtPayload<Payload>, secret: string | JsonWebKey | CryptoKey, options: JwtSignOptions<Header> | JwtAlgorithm = "HS256"): Promise<string> {
     if (typeof options === "string")
         options = { algorithm: options }