Skip to content

Commit

Permalink
fix: Prepend devtool handler (#1358)
Browse files Browse the repository at this point in the history
* Add prepend option to subscribe

* Prepend devtools subscribe handler to fix vuejs/devtools#678

Co-authored-by: Katashin <ktsn55@gmail.com>
  • Loading branch information
simplesmiler and ktsn committed Apr 23, 2020
1 parent f698a26 commit a39d076
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
16 changes: 14 additions & 2 deletions docs/api/README.md
Expand Up @@ -174,7 +174,7 @@ const store = new Vuex.Store({ ...options })
### subscribe
- `subscribe(handler: Function): Function`
- `subscribe(handler: Function, options?: Object): Function`
Subscribe to store mutations. The `handler` is called after every mutation and receives the mutation descriptor and post-mutation state as arguments:
Expand All @@ -185,13 +185,19 @@ const store = new Vuex.Store({ ...options })
})
```
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overriden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
``` js
store.subscribe(handler, { prepend: true })
```
To stop subscribing, call the returned unsubscribe function.
Most commonly used in plugins. [Details](../guide/plugins.md)
### subscribeAction
- `subscribeAction(handler: Function): Function`
- `subscribeAction(handler: Function, options?: Object): Function`
> New in 2.5.0
Expand All @@ -204,6 +210,12 @@ const store = new Vuex.Store({ ...options })
})
```
By default, new handler is added to the end of the chain, so it will be executed after other handlers that were added before. This can be overriden by adding `prepend: true` to `options`, which will add the handler to the beginning of the chain.
``` js
store.subscribe(handler, { prepend: true })
```
To stop subscribing, call the returned unsubscribe function.
> New in 3.1.0
Expand Down
4 changes: 2 additions & 2 deletions src/plugins/devtool.js
Expand Up @@ -18,9 +18,9 @@ export default function devtoolPlugin (store) {

store.subscribe((mutation, state) => {
devtoolHook.emit('vuex:mutation', mutation, state)
})
}, { prepend: true })

store.subscribeAction((action, state) => {
devtoolHook.emit('vuex:action', action, state)
})
}, { prepend: true })
}
14 changes: 8 additions & 6 deletions src/store.js
Expand Up @@ -164,13 +164,13 @@ export class Store {
})
}

subscribe (fn) {
return genericSubscribe(fn, this._subscribers)
subscribe (fn, options) {
return genericSubscribe(fn, this._subscribers, options)
}

subscribeAction (fn) {
subscribeAction (fn, options) {
const subs = typeof fn === 'function' ? { before: fn } : fn
return genericSubscribe(subs, this._actionSubscribers)
return genericSubscribe(subs, this._actionSubscribers, options)
}

watch (getter, cb, options) {
Expand Down Expand Up @@ -238,9 +238,11 @@ export class Store {
}
}

function genericSubscribe (fn, subs) {
function genericSubscribe (fn, subs, options) {
if (subs.indexOf(fn) < 0) {
subs.push(fn)
options && options.prepend
? subs.unshift(fn)
: subs.push(fn)
}
return () => {
const i = subs.indexOf(fn)
Expand Down

0 comments on commit a39d076

Please sign in to comment.