From 716500669f8098ba31e58aac50beed701254a2fb Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Sun, 9 Feb 2025 22:42:28 +0100 Subject: [PATCH] docs: new migration page --- packages/docs/.vitepress/config/en.ts | 4 +++ packages/docs/cookbook/migration-v2-v3.md | 31 +++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 packages/docs/cookbook/migration-v2-v3.md diff --git a/packages/docs/.vitepress/config/en.ts b/packages/docs/.vitepress/config/en.ts index c74153bd..0cb3dfb6 100644 --- a/packages/docs/.vitepress/config/en.ts +++ b/packages/docs/.vitepress/config/en.ts @@ -132,6 +132,10 @@ export const enConfig: LocaleSpecificConfig = { text: 'VSCode Snippets', link: '/cookbook/vscode-snippets.html', }, + { + text: 'Migration from v2 to v3', + link: '/cookbook/migration-v2-v3.html', + }, { text: 'Migration from v0/v1 to v2', link: '/cookbook/migration-v1-v2.html', diff --git a/packages/docs/cookbook/migration-v2-v3.md b/packages/docs/cookbook/migration-v2-v3.md new file mode 100644 index 00000000..448855f3 --- /dev/null +++ b/packages/docs/cookbook/migration-v2-v3.md @@ -0,0 +1,31 @@ +# Migrating from v2 to v3 + +Pinia v3 is a _boring_ major release with no new features. It drops deprecated APIs and updates major dependencies. It only supports Vue 3. If you are using Vue 2, you can keep using v2. You can probably just update Pinia's version but this guide is here to help you in case you encounter any issues. + +## Deprecations + +### `defineStore({ id })` + +The `defineStore()` signature that accepts an object with an `id` property is deprecated. You should use the `id` parameter instead: + +```ts +defineStore({ // [!code --] + id: 'storeName', // [!code --] +defineStore('storeName', { // [!code ++] + // ... +}) +``` + +### `PiniaStorePlugin` + +This deprecated type alias has been removed in favor of `PiniaPlugin`. + +## New versions + +- Only Vue 3 is supported. +- TypeScript 5 or newer is required. +- The devtools API has been upgraded to [v7](https://devtools.vuejs.org). + +## Nuxt + +The Nuxt module has been updated to support Nuxt 3. If you are using Nuxt 2 or Nuxt bridge, you can keep using the old version of Pinia. -- 2.47.3