tsndr/cloudflare-worker-jwt
1
0
Fork 0
Code Activity

update readme

Browse Source
This commit is contained in:
Toby
2023-10-02 23:18:05 +02:00
parent 6ac43d493d
commit 47028970b4
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -104,7 +104,7 @@ Argument | Type | Status | Default | Description
----------- | -------- | -------- | ------- | ----------- ----------- | -------- | -------- | ------- | -----------
`token` | `string` | required | - | The token string generated by `jwt.sign()`. `token` | `string` | required | - | The token string generated by `jwt.sign()`.
`secret` | `string` | required | - | The string which was used to sign the payload. `secret` | `string` | required | - | The string which was used to sign the payload.
`options` | `object` | optional | `{ algorithm: 'HS256', throwError: false }` | The options object supporting `algorithm` and `throwError`. (See [Available Algorithms](#available-algorithms)) `options` | `object` | optional | `{ algorithm: 'HS256', skipValidation: false, throwError: false }` | The options object supporting `algorithm`, `skipValidation` and `throwError`. (See [Available Algorithms](#available-algorithms))
#### `throws` #### `throws`
If `options.throwError` is `true` and the token is invalid, an error will be thrown. If `options.throwError` is `true` and the token is invalid, an error will be thrown.