JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 16930
  • Score
    100M100P100Q136259F
  • License BSD-3-Clause

Rpc and pub/sub between Python and JavaScript over WebSockets

Package Exports

  • wslink
  • wslink/dist/wslink.js
  • wslink/src/SmartConnect
  • wslink/src/SmartConnect/index.js
  • wslink/src/WebsocketConnection
  • wslink/src/WebsocketConnection/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wslink) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

wslink

Wslink allows easy, bi-directional communication between a python server and a javascript client over a websocket. The client can make RPC calls to the server, and the server can publish messages to topics that the client can subscribe to. The server can include binary attachments in these messages, which are communicated as a binary websocket message, avoiding the overhead of encoding and decoding.

RPC and publish/subscribe

The initial users of wslink driving its development are VTK and ParaViewWeb. ParaViewWeb and vtkWeb require:

  • RPC - a remote procedure call that can be fired by the client and return sometime later with a response from the server, possibly an error.

  • Publish/subscribe - client can subscribe to a topic provided by the server, possibly with a filter on the parts of interest. When the topic has updated results, the server publishes them to the client, without further action on the client's part.

Get the whole story

This package is just the client side of wslink. See the github repo for the full story - and to contribute or report issues!

License

Free to use in open-source and commercial projects, under the BSD-3-Clause license.