metarhia/jstp

Unmatched README

thundernet8 opened this issue · 3 comments

For the demo code in README of master branch, I run test of it, two issues:

  1. jstp.net.createServer should be jstp.tcp.createServer, the jstp.net new api not implemented in the latest package

  2. function handleConnect(error, connection, app) should be function handleConnect(error, connection, sid, app)

I think the new API code has not been merged to master

aqrln commented

Hi and thanks for reaching out! The new API has already been merged to master as per 7c351fb (#209) for the former issue and b6e9eee (#104) for the latter one. I believe you are running the demo using the package from npm, not from the master branch. I have to admit that a mismatch between the API shown on the landing page of the project (which essentially a README is) and the actual API of the latest npm package is no less confusing though, so sorry for that. We are planning that the new version will have been released by the end of this month.

EDIT: swapped the references to commits

thanks, got it

As a temporary workaround while there is no new version of our package in npm, you can use the version from the git repository, by installing the package like this: npm install metarhia/jstp