SocketCluster / SocketCluster/socketcluster-client
Question - wrapping sc client
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 300
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
@jondubois Hey man, if I do this would it cause any issues? I've tested it locally and it works fine. Basically, I'm trying to wrap promises around emit and publish for the client.
Thanks!
import * as SC from 'socketcluster-client'
import * as Emitter from 'component-emitter'
export function install (_Vue,options) {
function vue2SocketclusterInit() {
var opts = this.$options
if (opts.socket) {
this.$socket = opts.socket
} else if (opts.parent && opts.parent.$socket) {
this.$socket = opts.parent.$socket
} else {
let soc = SC.connect(options)
soc.emit = function(event,data,callback) {
return new Promise((resolve,reject) => {
if (soc._localEvents[event] == null) {
return soc._emit(event,data,(err,res) => {
callback && callback(err,res)
if (err) return reject(err)
return resolve(res)
})
}
Emitter.prototype.emit.call(soc, event, data)
})
}
soc.publish = function(channelName,data,callback) {
return new Promise((resolve,reject) => {
let pubData = {
channel:soc._decorateChannelName(channelName),
data
}
soc._emit('#publish',pubData,(err,res) => {
callback && callback(err,res)
if (err) return reject(err)
return resolve(res)
})
})
}
this.$socket = soc
}
}
var usesInit = _Vue.config._lifecycleHooks.indexOf('init') > -1
_Vue.mixin(usesInit ? { init: vue2SocketclusterInit } : { beforeCreate: vue2SocketclusterInit })
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the client entry points shown in the issue: emit, publish, _emit, _localEvents, and _decorateChannelName. Compare the proposed Promise wrappers with the existing callback behavior and local event handling. Done would require a clearly agreed API change and confirmation that both callback and Promise usage behave correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100