You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -25,16 +25,16 @@ $ npm install jsonwebtoken
25
25
26
26
(Synchronous) Returns the JsonWebToken as string
27
27
28
-
`payload` could be an object literal, buffer or string representing valid JSON. *Please note that*`exp` is only set if the payload is an object literal. Buffer or string payloads are not checked for JSON validity.
28
+
`payload` could be an object literal, buffer or string representing valid JSON. *Please note that*`exp`or any other claim is only set if the payload is an object literal. Buffer or string payloads are not checked for JSON validity.
29
29
30
30
`secretOrPrivateKey` is a string, buffer, or object containing either the secret for HMAC algorithms or the PEM
31
31
encoded private key for RSA and ECDSA. In case of a private key with passphrase an object `{ key, passphrase }` can be used (based on [crypto documentation](https://nodejs.org/api/crypto.html#crypto_sign_sign_private_key_output_format)), in this case be sure you pass the `algorithm` option.
32
32
33
33
`options`:
34
34
35
35
*`algorithm` (default: `HS256`)
36
-
*`expiresIn`: expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `60`, `"2 days"`, `"10h"`, `"7d"`
37
-
*`notBefore`: expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `60`, `"2 days"`, `"10h"`, `"7d"`
36
+
*`expiresIn`: expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `60`, `"2 days"`, `"10h"`, `"7d"`. A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default (`"120"` is equal to `"120ms"`).
37
+
*`notBefore`: expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `60`, `"2 days"`, `"10h"`, `"7d"`. A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default (`"120"` is equal to `"120ms"`).
38
38
*`audience`
39
39
*`issuer`
40
40
*`jwtid`
@@ -134,7 +134,7 @@ As mentioned in [this comment](https://github.com/auth0/node-jsonwebtoken/issues
134
134
*`ignoreNotBefore`...
135
135
*`subject`: if you want to check subject (`sub`), provide a value here
136
136
*`clockTolerance`: number of seconds to tolerate when checking the `nbf` and `exp` claims, to deal with small clock differences among different servers
137
-
*`maxAge`: the maximum allowed age for tokens to still be valid. It is expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `1000`, `"2 days"`, `"10h"`, `"7d"`.
137
+
*`maxAge`: the maximum allowed age for tokens to still be valid. It is expressed in seconds or a string describing a time span [zeit/ms](https://github.com/zeit/ms). Eg: `1000`, `"2 days"`, `"10h"`, `"7d"`. A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default (`"120"` is equal to `"120ms"`).
138
138
*`clockTimestamp`: the time in seconds that should be used as the current time for all necessary comparisons.
0 commit comments