Skip to content

jwayong/x-websocket

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<x-websocket> Bower Version

A Polymer/WebComponent wrapper of WebSocket client.

Usage

  1. Install the component using Bower:

    $ bower install x-websocket --save
  2. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
  3. Import Custom Element:

    <link rel="import" href="bower_components/x-websocket/dist/x-websocket.html">
  4. Start using it!

    <x-websocket url="ws://echo.websocket.org"></x-websocket>

Options

Attribute Options Default Description
url string undefined WebSocket server endpoint to connect to. Usually starts with ws:// or wss://.
json bool false Automatically JSON-encode sent messages and JSON-decode received messages.
jsonSend bool false Automatically JSON-encode sent messages, even if json is false.
jsonReceive bool false Automatically JSON-decode recieved messages, even if json is false.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License

About

WebComponent WebSocket wrapper.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 92.9%
  • JavaScript 7.1%