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

Updated readme

Browse Source
This commit is contained in:
Toby
2021-02-04 12:42:33 +01:00
parent 4e461a14b9
commit b45c5ed2e0
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -29,33 +29,48 @@ const payload = jwt.decode(token)
Signs a payload and returns the token. Signs a payload and returns the token.
`payload` `payload`
Can be an object, buffer or a string.
The payload object.
`secret` `secret`
A string which is used to sign the payload. A string which is used to sign the payload.
`algorithm` (optional, default: `HS256`) `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])` ### `jwt.verify(token, secret, [algorithm])`
Verifies the integrity of the token and returns a boolean value. Verifies the integrity of the token and returns a boolean value.
`token` `token`
The token string generated by `jwt.sign()`. The token string generated by `jwt.sign()`.
`secret` `secret`
A string which is used to sign the payload. A string which is used to sign the payload.
`algorithm` (optional, default: `HS256`) `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)` ### `jwt.decode(token)`
Returns the payload without verifying the integrity of the token. Returns the payload without verifying the integrity of the token.
`token` `token`
The token string generated by `jwt.sign()`. The token string generated by `jwt.sign()`.