From 8f4e5e3199313b3008b35ff2dcc003f091686274 Mon Sep 17 00:00:00 2001 From: Tobias Schneider Date: Sat, 4 Jun 2022 22:29:30 +0200 Subject: [PATCH] Docs fix --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5512b59..7c201ae 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ Argument | Type | Satus | 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`, `string` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid` or just the algorithm string. (See [Available Algorithms](#available-algorithms)) +`options` | `object` | optional | `{ algorithm: 'HS256' }` | The options object supporting `algorithm` and `keyid`. (See [Available Algorithms](#available-algorithms)) #### `return` Returns token as a `string`. @@ -104,7 +104,7 @@ Argument | Type | Satus | 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`, `string` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms)) +`options` | `object` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms)) #### `throws` If `options.throwError` is `true` and the token is invalid, an error will be thrown.