Skip to content

Commit

Permalink
Merge branch 'master' into alpha
Browse files Browse the repository at this point in the history
# Conflicts:
#	package-lock.json
#	package.json
  • Loading branch information
probil committed Apr 2, 2021
2 parents 6809113 + 68d28f2 commit 05620af
Show file tree
Hide file tree
Showing 12 changed files with 5,478 additions and 6,305 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
node_modules/
npm-debug.log
.idea/
dist/

# Release notes
RELEASE_NOTE*.md
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<p align="center">
Socket.io bindings for Vue.js and Vuex (inspired by Vue-Socket.io)
Socket.io bindings for Vue.js 2 and Vuex (inspired by Vue-Socket.io)
</p>

<p align="center">
Expand All @@ -23,6 +23,10 @@
<a href='https://ko-fi.com/R5R1119O3' target='_blank'><img height='36' style='border:0;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=2' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
</p>


> :warning: [The alpha version of v5](https://github.com/probil/vue-socket.io-extended/tree/alpha) (with Vue 3 support) has been released. Your feedback would be appreciated [here](https://github.com/probil/vue-socket.io-extended/issues/489)

## :cherries: Features

- Lightweight and dependency free - only 2kb min gzip
Expand Down Expand Up @@ -332,6 +336,7 @@ Here they are:
| `mutationPrefix` | `String` | `'SOCKET_'` | Prepend to event name while converting event to mutation. Empty string disables prefixing |
| `eventToMutationTransformer` | `Function` `string => string` | uppercase function | Determines how event name converted to mutation |
| `eventToActionTransformer` | `Function` `string => string` | camelcase function | Determines how event name converted to action |
| eventMapping | `Function` `socket => string` | | Map your event from socket event data

*FYI:* You can always access default plugin options if you need it (e.g. re-use default `eventToActionTransformer` function):

Expand Down
1 change: 0 additions & 1 deletion dist/vue-socket.io-ext.esm.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/vue-socket.io-ext.min.js

This file was deleted.

Loading

0 comments on commit 05620af

Please sign in to comment.