feat: deprecation message createStore

diff --git a/src/index.ts b/src/index.ts
index 8e4abc28f3dbd907251efda6663b9daf5cb7f990..55b5466924eb49aee94e2bb0ad029fb8db4b74c8 100644 (file)
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,10 +1,17 @@
-import { createStore } from './store'
+import { defineStore } from './store'
 export {
   setActiveReq,
   setStateProvider,
   getRootState,
   createPinia,
 } from './rootStore'
+
+function createStore(options: Parameters<typeof defineStore>[0]) {
+  console.warn(
+    '[🍍]: "createStore" has been deprecated and will be removed on the sable release, use "defineStore" instead.'
+  )
+  return defineStore(options)
+}
+
 export { StateTree, StoreGetter, Store } from './types'
-// TODO: deprecate createStore
-export { createStore, createStore as defineStore }
+export { createStore, defineStore }

diff --git a/src/store.ts b/src/store.ts
index bc5b4ca16c82898a7791747e87ee5c09f7c8e7b2..88949c6ef00a8714ded79289c4ad60b61fb56ac4 100644 (file)
--- a/src/store.ts
+++ b/src/store.ts
@@ -188,7 +188,7 @@ let isDevWarned: boolean | undefined
  * Creates a `useStore` function that retrieves the store instance
  * @param options - options to define the store
  */
-export function createStore<
+export function defineStore<
   Id extends string,
   S extends StateTree,
   G /* extends Record<string, StoreGetterThis> */,