amirho/expressjs.com
1
0
Fork 0
mirror of https://github.com/expressjs/expressjs.com.git synced 2026-02-21 19:41:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update res.clearCookie documentation for clarity and accuracy (#2000)

Browse Source 
Improve the message by expanding on how the cookie is cleared, and
include a note about the deprecation of the `max-age` and `expires`
options: in Express 4 they are still respected (not ignored), whereas in
Express 5 they are ignored.

ref: https://github.com/expressjs/express/pull/5792
ref: https://github.com/expressjs/express/issues/5640
ref: https://github.com/expressjs/express/pull/5672

closes: https://github.com/expressjs/expressjs.com/issues/1146

Note: We need to manage changes more effectively. Whenever there are
changes, and once they have been released, a PR should be opened here to
update the documentation. Improving these processes will help us keep
our documentation better maintained.

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>

Co-authored-by: ShubhamOulkar <91728992+ShubhamOulkar@users.noreply.github.com>
This commit is contained in:
Sebastian Beltran
2025-08-15 16:29:10 -05:00
committed by GitHub
parent 10929d355c
commit 8c1e4b39a2
2 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
_includes/api/en/4x/res-clearCookie.md
View File

@@ -1,6 +1,14 @@
<h3 id='res.clearCookie'>res.clearCookie(name [, options])</h3>
Clears the cookie specified by `name`. For details about the `options` object, see [res.cookie()](#res.cookie).
Clears the cookie with the specified `name` by sending a `Set-Cookie` header that sets its expiration date in the past.
This instructs the client that the cookie has expired and is no longer valid. For more information
about available `options`, see [res.cookie()](#res.cookie).
<div class="doc-box doc-warn" markdown="1">
If the `maxAge` or `expires` options are set, the cookie may not be cleared depending on the time values provided,
as Express does not ignore these options. It is therefore recommended to omit these options when calling this
method. Passing these two options has been deprecated since Express v4.20.0.
</div>
<div class="doc-box doc-notice" markdown="1">
Web browsers and other compliant clients will only clear the cookie if the given

11
_includes/api/en/5x/res-clearCookie.md
View File

@@ -1,11 +1,16 @@
<h3 id='res.clearCookie'>res.clearCookie(name [, options])</h3>
Clears the cookie specified by `name`. For details about the `options` object, see [res.cookie()](#res.cookie).
Clears the cookie with the specified `name` by sending a `Set-Cookie` header that sets its expiration date in the past.
This instructs the client that the cookie has expired and is no longer valid. For more information
about available `options`, see [res.cookie()](#res.cookie).
<div class="doc-box doc-notice" markdown="1">
The `expires` and `max-age` options are being ignored completely.
</div>
<div class="doc-box doc-notice" markdown="1">
Web browsers and other compliant clients will only clear the cookie if the given
`options` is identical to those given to [res.cookie()](#res.cookie), excluding
`expires` and `maxAge`.
`options` is identical to those given to [res.cookie()](#res.cookie)
</div>
```js