Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0a3a9b58d1 | |||
| 959a7c9490 |
21
README.md
21
README.md
@@ -29,33 +29,48 @@ const payload = jwt.decode(token)
|
||||
|
||||
Signs a payload and returns the token.
|
||||
|
||||
|
||||
`payload`
|
||||
Can be an object, buffer or a string.
|
||||
|
||||
The payload object.
|
||||
|
||||
|
||||
`secret`
|
||||
|
||||
A string which is used to sign the payload.
|
||||
|
||||
|
||||
`algorithm` (optional, default: `HS256`)
|
||||
The algorithm used to sign the payload, possible values: `HS256`(default) or `HS512`
|
||||
|
||||
The algorithm used to sign the payload, possible values: `HS256` or `HS512`
|
||||
|
||||
|
||||
### `jwt.verify(token, secret, [algorithm])`
|
||||
|
||||
Verifies the integrity of the token and returns a boolean value.
|
||||
|
||||
|
||||
`token`
|
||||
|
||||
The token string generated by `jwt.sign()`.
|
||||
|
||||
|
||||
`secret`
|
||||
|
||||
A string which is used to sign the payload.
|
||||
|
||||
|
||||
`algorithm` (optional, default: `HS256`)
|
||||
The algorithm used to sign the payload, possible values: `HS256`(default) or `HS512`
|
||||
|
||||
The algorithm used to sign the payload, possible values: `HS256` or `HS512`
|
||||
|
||||
### `jwt.decode(token)`
|
||||
|
||||
Returns the payload without verifying the integrity of the token.
|
||||
|
||||
|
||||
`token`
|
||||
|
||||
The token string generated by `jwt.sign()`.
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@tsndr/cloudflare-worker-jwt",
|
||||
"version": "1.0.1",
|
||||
"version": "1.0.2",
|
||||
"description": "A lightweight JWT implementation with ZERO dependencies for Cloudflare Worker",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
|
||||
Reference in New Issue
Block a user