dva-socket.io
A socket.io plugin for dva dva or Redux.
Usage
// Simple Usage;; const app = ; app;
// Normal Usage (Recommend);; const app = ; app;
// With Async Service;; const app = ; app;
Api
createSocket(url, options, rules)
- @param
url: String
: socket.io url - @param
options: Object
: socket.io options - @param
rules: Object
: listeners(on), emitters(emit)on: Object | Array
key: String | number
as a listen event namevalue: Function
as a listen handle function- @params
data: Server Push Value
- @params
dispatch: Redux dispatch Function
- @params
emit: Object | Array
key: String
as a listen event namevalue: Object
as an Object { evaluate, data }evaluate: Function
as a validate function, only if evaluate returntrue
, it will emit akey
event withdata
- @params
action: Redux dispatched Action
- @params
dispatch: Redux dispatch Function
- @params
data: Function | Value
as a emit data provider- @params
action: Server Push Value
- @params
asyncs: Array
evaluate: Function
as a validate function, only if evaluate returntrue
, it will callrequest
- @params
action: Redux dispatched Action
- @params
dispatch: Redux dispatch Function
- @params
request: Async Function
as async request service- @params
action: Redux dispatched Action
- @params
dispatch: Redux dispatch Function
- @params
- @return
DVA PLUGIN