A way to detect a composable is being used in setup store

[MartinMalinda]

What problem is this solving

In vue-concurrency I have a composable called "useTask" and most common usecase for it is to run it in components. But there's also usecase for global tasks and pinia is a good fit.

Currently I issue a warning in the console when a task is being used outside of component setup. Which is annoying if someone uses it in pinia.

It would be great if I, as a library author, could detect that the composable is being run inside pinia. I could then turn of this warning.

Proposed solution

I can imagine I could use an equivalent to getCurrentInstance as I already use getCurrentInstance to detect if the task is correctly created inside setup.

So something like getCurrentStore() although it could be confused with getActivePinia().

Alternatively I could just look up some flag on some global object? This would also mean I don't have to have pinia as dependency.

Describe alternatives you've considered

I can provide an API to explicitly turn off the warnings but it would be great if I didn't have to do this.

[posva]

You can use getCurrentScope() to know if you are within an effect scope.

You shouldn't need pinia as a dependency, that's for sure. In library code, you can check for a currentInstance and conditionally setup hooks if needed but for onUnmounted() you can also use onScopeDispose(). This should make your library work with libraries other than Pinia that use the same pattern

[MartinMalinda]

that's perfect, I didn't know about this function, thank you! 🙏