feat: mark getters as readonly

diff --git a/src/store.ts b/src/store.ts
index cfe8a3c75abe98086a745da8616dc3961455a9b1..fe96a9242e23526f0eb6a83b861f2805151f9af5 100644 (file)
--- a/src/store.ts
+++ b/src/store.ts
@@ -229,6 +229,7 @@ function buildStoreToUse<
 
   const computedGetters: StoreWithGetters<G> = {} as StoreWithGetters<G>
   for (const getterName in getters) {
+    // @ts-ignore: it's only readonly for the users
     computedGetters[getterName] = computed(() => {
       setActivePinia(pinia)
       // eslint-disable-next-line @typescript-eslint/no-use-before-define

diff --git a/src/types.ts b/src/types.ts
index ee3102106d79414be48aabf9ad5be8ff4290e804..bd1ed9adc9de23d7a7045c148c1aff3b28369faa 100644 (file)
--- a/src/types.ts
+++ b/src/types.ts
@@ -122,7 +122,10 @@ export type StoreWithActions<A> = {
  * @internal
  */
 export type StoreWithGetters<G> = {
-  [k in keyof G]: G[k] extends (this: infer This, store?: any) => infer R
+  readonly [k in keyof G]: G[k] extends (
+    this: infer This,
+    store?: any
+  ) => infer R
     ? R
     : never
 }

diff --git a/test-dts/store.test-d.ts b/test-dts/store.test-d.ts
index e1a02adfd0123d3180d50a38fe7bee6cd6cc1fb4..fcb4bee32f51ad6e8618849e65ad24fe90349174 100644 (file)
--- a/test-dts/store.test-d.ts
+++ b/test-dts/store.test-d.ts
@@ -33,6 +33,9 @@ expectType<'on' | 'off'>(store.a)
 // @ts-expect-error
 store.nonExistant
 
+// @ts-expect-error
+store.upper = 'thing'
+
 // @ts-expect-error
 store.nonExistant.stuff