update readme

tsndr · Feb 22, 2024 · 37fdf4f · 37fdf4f
1 parent e503b16
commit 37fdf4f
Showing 1 changed file with 17 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -84,11 +84,13 @@ Signs a payload and returns the token.
 
 #### Arguments
 
-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`   | `object` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid`. (See [Available Algorithms](#available-algorithms))
+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.
 
 #### `return`
 Returns token as a `string`.
@@ -100,11 +102,15 @@ Returns token as a `string`.
 
 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`   | `object` | optional | `{ algorithm: 'HS256', skipValidation: false, throwError: false }` | The options object supporting `algorithm`, `skipValidation` and `throwError`. (See [Available Algorithms](#available-algorithms))
+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.
+
 
 #### `throws`
 If `options.throwError` is `true` and the token is invalid, an error will be thrown.
@@ -147,4 +153,4 @@ Returns an `object` containing `header` and `payload`:
  - HS512
  - RS256
  - RS384
- - RS512
+ - RS512