mirror of https://github.com/cypress-io/cypress.git synced 2026-03-10 11:30:17 -05:00

Files

Gleb Bahmutov 05210dc24a Update package readmes for #516 (#569 )

* update packages/driver readme close #516 

* update packages/electron readme

* update packages/extension readme

* update packages/http-proxy readme and cross-env

* update packages/launcher readme

* update bin-up

* update reporter readme

* update runner readme

* update socket readme

2017-10-05 18:38:06 +00:00

1.0 KiB

Raw Blame History

Cypress Core Socket

This is a shared lib for holding both the socket.io server and client.

Usage

var socket = require("packages/core-socket")

// returns
{
  server: require("socket.io"),
  client: require("socket.io-client"),
  getPathToClientSource: function(){
    // returns path to the client 'socket.io.js' file
    // for use in the browser
  }
}

var socket = require("packages/core-socket")

// server usage
var srv = require("http").createServer()
var io = socket.server(srv)
io.on("connection", function(){})

// client usage
var client = socket.client("http://localhost:2020")
client.on("connect", function(){})
client.on("event", function(){})
client.on("disconnect", function(){})

// path usage
socket.getPathToClientSource()
// returns your/path/to/node_modules/socket.io-client/socket.io.js0

Install

Root install is preferred (see CONTRIBUTING.md), but if you must

npm install

Development

Watching

npm run test-watch

Testing

npm test

1.0 KiB Raw Blame History