How to subscribe to a specific action in Pinia

Question

Does anyone know if it's possible to subscribe to a specific action in Pinia? I know there's a way to subscribe to all actions like this:

const subscribe = someStore.$onAction(callback, false)

But that means I have to compare action name to the one I want within the callback, like this:

websocketStore.$onAction(
  ({name}) => {
    if (name === 'specificAction') {
      console.log('do something')
    }
  }
)

So I wonder if there's a way to it better? (I'm using Pinia with Nuxt3)

Did you figure this out? I would also like to know how to do it :) — Nadia, Jun 22 '22 at 21:35
You can find the doc here explaining how to do it: https://pinia.vuejs.org/core-concepts/actions.html#subscribing-to-actions — elverde, Mar 09 '23 at 10:51
@elverde Most of the question is stating that the OP knows about that, but wants to know if there is a better way. — Darryl Noakes, Mar 09 '23 at 15:25

score 1 · Answer 1 · answered Jan 22 '23 at 08:09

There is no official documentation to do it but we can create a plugin to perform same operation.

pinia.use(({ store }) => {
  let oldAction = store.$onAction;
  store.$onAction = function(action, cb){
      olddAction((ctx) => {
          if (ctx.name === action) cb.call(store);
      }
  }
})

Not tried it because never required, you can change plugin definition according to you.

score -1 · Answer 2 · answered Nov 10 '22 at 15:40

Subscribing to actions

It is possible to observe actions and their outcome with store.$onAction(). The callback passed to it is executed before the action itself. after handling promises and allows you to execute a function after the action resolves. In a similar way, onError allows you to execute a function if the action throws or rejects.

export default {
  setup() {
    const someStore = useSomeStore()

    // this subscription will be kept even after the component is unmounted
    someStore.$onAction(callback, true)

    // ...
  },
}

Pinia official documentation

He specifically states that he knows about `store.$onAction`, but that it is not "clean". He wants to know if there is a way to subscribe to a _specific_ action. — Darryl Noakes, Nov 11 '22 at 19:47

How to subscribe to a specific action in Pinia

2 Answers2

Subscribing to actions