archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add clarity for deleting cookies (#52338)

Browse source 
Added additional methods for deleting a cookie




Co-authored-by: Lee Robinson <9113740+leerob@users.noreply.github.com>
Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
This commit is contained in:
Jarrett Meyer 2023-08-02 13:02:51 -04:00 committed by GitHub
parent 269114b5cc
commit c7fa524ebd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
docs/02-app/02-api-reference/04-functions/cookies.mdx
View file

@ -85,9 +85,13 @@ async function create(data) {
## Deleting cookies
To "delete" a cookie, you must set a new cookie with the same name and an empty value. You can also set the `maxAge` to `0` to expire the cookie immediately.
> **Good to know**: You can only delete cookies in a [Server Action](/docs/app/building-your-application/data-fetching/server-actions) or [Route Handler](/docs/app/building-your-application/routing/route-handlers).
> **Good to know**: `.set()` is only available in a [Server Action](/docs/app/building-your-application/data-fetching/server-actions) or [Route Handler](/docs/app/building-your-application/routing/route-handlers).
There are several options for deleting a cookie:
### `cookies().delete(name)`
You can explicitly delete a cookie with a given name.
```js filename="app/actions.js"
'use server'
@ -95,16 +99,56 @@ To "delete" a cookie, you must set a new cookie with the same name and an empty
import { cookies } from 'next/headers'
async function create(data) {
cookies().set({
name: 'name',
value: '',
expires: new Date('2016-10-05'),
path: '/', // For all paths
})
cookies().delete('name')
}
```
You can only set cookies that belong to the same domain from which `.set()` is called. Additionally, the code must be executed on the same protocol (HTTP or HTTPS) as the cookie you want to update.
### `cookies().set(name, '')`
Alternatively, you can set a new cookie with the same name and an empty value.
```js filename="app/actions.js"
'use server'
import { cookies } from 'next/headers'
async function create(data) {
cookies().set('name', '')
}
```
> **Good to know**: `.set()` is only available in a [Server Action](/docs/app/building-your-application/data-fetching/server-actions) or [Route Handler](/docs/app/building-your-application/routing/route-handlers).
### `cookies().set(name, value, { maxAge: 0 })`
Setting `maxAge` to 0 will immediately expire a cookie.
```js filename="app/actions.js"
'use server'
import { cookies } from 'next/headers'
async function create(data) {
cookies().set('name', 'value', { maxAge: 0 })
}
```
### `cookies().set(name, value, { expires: timestamp })`
Setting `expires` to any value in the past will immediately expire a cookie.
```js filename="app/actions.js"
'use server'
import { cookies } from 'next/headers'
async function create(data) {
const oneDay = 24 * 60 * 60 * 1000
cookies().set('name', 'value', { expires: Date.now() - oneDay })
}
```
> **Good to know**: You can only delete cookies that belong to the same domain from which `.set()` is called. Additionally, the code must be executed on the same protocol (HTTP or HTTPS) as the cookie you want to delete.
## Version History