Neutrinos Peludos Magnéticos
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

phoenix-channels

1.0.0 • Public • Published

Phoenix Channels Client

This is the Node.js client. If you need a client for the browser use phoenix

The differece with the original client is that this does not use long-polling and you need to pass the absolute url instead of the relative url.

Usage

This uses the same API as the original phoenix except that it needs an absolute url

const { Socket } = require('phoenix-channels')
 
let socket = new Socket("ws://example.com/socket")
 
socket.connect()
 
// Now that you are connected, you can join channels with a topic:
let channel = socket.channel("room:lobby", {})
channel.join()
  .receive("ok", resp => { console.log("Joined successfully", resp) })
  .receive("error", resp => { console.log("Unable to join", resp) })

Presence is also available

Installation

npm install --save phoenix-channels

Authors

API was made by authors of the Phoenix Framework

  • see their website for complete list of authors.

Ported to Node.js by Mario Campa

License

The same as Phoenix Framework (MIT)

Keywords

none

install

npm i phoenix-channels

Downloadsweekly downloads

6

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability