Iterate over all stores - is _s an API guarantee?

[davidAtInleague]

Hi, I'm looking to {get a listing of, iterate over} all stores in my application. This is in support of running hooks against any stores implementing particular interfaces at certain times in the application lifecycle (onLogout, etc.). In #911 there seems to be a common solution of the form:

import { getActivePinia } from "pinia"

// map through that list and use the **$reset** fn to reset the state
getActivePinia()._s.forEach(store => store.$reset());

Which is a fine solution, assuming _s never changes its implementation's name or shape.

Is the _s property on Pinia instances an API guarantee? If not, can it be made so (or something similar, to enable iterating over all registered stores)?

[posva]

_s is internal so it could change anytime and it wouldn't be a major version. It's unlikely to disappear though as it's crucial internally. You can create a similar solution with a plugin:

const stores = new Set()
pinia.use(({ store }) => {
  stores.add(store)
})

[tintin10q]

Here is typed solution:

import { Store } from "pinia";

const AllPiniaStores = new Set<Store>();
pinia.use(({ store }) => {
  AllPiniaStores.add(store);
  store.$all = AllPiniaStores;
  store.$reset_all = () => store.$all.forEach((s) => s.$reset());
});

declare module "pinia" {
  export interface PiniaCustomProperties {
    $all: typeof AllPiniaStores;
    /** Reset all the stores */
    $reset_all: () => void;
  }
}

[hjisaac]

Good 👍 , but this way, you give each store the ability TO RESET OTHER STORES OF THE APP. It doesn't look like a good pattern though.

[tintin10q]

I guess but that was that ability was already there with _s

[hjisaac]

No, because the "_s" is a property of the active pinia instance and not of a specific store 👍 .