Skip to content

Commit ac33290

Browse files
committed
docs: fix documentation of signedCookie return value
fixes #32
1 parent 007fe69 commit ac33290

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Given an object, this will iterate over the keys and call `JSONCookie` on each v
4242

4343
### cookieParser.signedCookie(str, secret)
4444

45-
Parse a cookie value as a signed cookie. This will return the parsed unsigned value if it was a signed cookie and the signature was valid, otherwise it will return the passed value.
45+
Parse a cookie value as a signed cookie. This will return the parsed unsigned value if it was a signed cookie and the signature was valid. If the value was not signed, the original value is returned. If the value was signed but the signature could not be validated, `false` is returned.
4646

4747
The `secret` argument can be an array or string. If a string is provided, this is used as the secret. If an array is provided, an attempt will be made to unsign the cookie with each secret in order.
4848

0 commit comments

Comments
 (0)