Nuxt/docs/3.api/3.utils/refresh-cookie.md

47 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

---
title: "refreshCookie"
description: "Refresh useCookie values manually when a cookie has changed"
navigation:
badge: New
links:
- label: Source
icon: i-simple-icons-github
to: https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/composables/cookie.ts
size: xs
---
::important
This utility is available since [Nuxt v3.10](/blog/v3-10).
::
## Purpose
The `refreshCookie` function is designed to refresh cookie value returned by `useCookie`.
This is useful for updating the `useCookie` ref when we know the new cookie value has been set in the browser.
## Usage
```vue [app.vue]
<script setup lang="ts">
const tokenCookie = useCookie('token')
const login = async (username, password) => {
const token = await $fetch('/api/token', { ... }) // Sets `token` cookie on response
refreshCookie('token')
}
const loggedIn = computed(() => !!tokenCookie.value)
</script>
```
::note{to="/docs/guide/going-further/experimental-features#cookiestore"}
You can enable experimental `cookieStore` option to automatically refresh `useCookie` value when cookie changes in the browser.
::
## Type
```ts
refreshCookie(name: string): void
```