\n\n## Contents\n\n- [Installation](#installation)\n- [Basic Usage](#usage)\n- [Advanced Usage](#advanced-usage)\n- [Typescript Support](#typescript-support)\n- [Socket.IO](#socket-io)\n- [Contributing](#contributing)\n- [Feedback](#feedback)\n\n## Installation\n\n```shell\nnpm install mock-socket\n```\n\n```js\nimport { WebSocket, Server } from 'mock-socket';\n```\n\n## Usage\n\n```js\nimport test from 'ava';\nimport { Server } from 'mock-socket';\n\nclass ChatApp {\n constructor(url) {\n this.messages = [];\n this.connection = new WebSocket(url);\n\n this.connection.onmessage = event => {\n this.messages.push(event.data);\n };\n }\n\n sendMessage(message) {\n this.connection.send(message);\n }\n}\n\ntest.cb('that chat app can be mocked', t => {\n const fakeURL = 'ws://localhost:8080';\n const mockServer = new Server(fakeURL);\n\n mockServer.on('connection', socket => {\n socket.on('message', data => {\n t.is(data, 'test message from app', 'we have intercepted the message and can assert on it');\n socket.send('test message from mock server');\n });\n });\n\n const app = new ChatApp(fakeURL);\n app.sendMessage('test message from app'); // NOTE: this line creates a micro task\n\n // NOTE: this timeout is for creating another micro task that will happen after the above one\n setTimeout(() => {\n t.is(app.messages.length, 1);\n t.is(app.messages[0], 'test message from mock server', 'we have stubbed our websocket backend');\n mockServer.stop(t.done);\n }, 100);\n});\n```\n\n## Advanced Usage\n\n### Stubbing the \"global\"\n\n```js\nimport { WebSocket, Server } from 'mock-socket';\n\n/*\n * By default the global WebSocket object is stubbed out when \n * a new Server instance is created and is restored when you stop\n * the server.\n * However, you can disable this behavior by passing `mock: false`\n * to the options and manually mock the socket when you need it.\n */\nconst server = new Server('ws://localhost:8080', { mock: false });\n\n/*\n * If you need to stub something else out you can like so:\n */\n\nwindow.WebSocket = WebSocket; // Here we stub out the window object\n```\n\n### Server Methods\n\n```js\nconst mockServer = new Server('ws://localhost:8080');\n\nmockServer.on('connection', socket => {\n socket.on('message', () => {});\n socket.on('close', () => {});\n socket.on('error', () => {});\n\n socket.send('message');\n socket.close();\n});\n\nmockServer.clients(); // array of all connected clients\nmockServer.emit('room', 'message');\nmockServer.stop(optionalCallback);\n```\n\n## Typescript Support\n\nA [declaration file](https://github.com/thoov/mock-socket/blob/master/index.d.ts) is included by default. If you notice any issues with the types please create an issue or a PR!\n\n## Socket IO\n\n[Socket.IO](https://socket.io/) has **limited support**. Below is a similar example to the one above but modified to show off socket.io support.\n\n```js\nimport test from 'ava';\nimport { SocketIO, Server } from 'mock-socket';\n\nclass ChatApp {\n constructor(url) {\n this.messages = [];\n this.connection = new io(url);\n\n this.connection.on('chat-message', data => {\n this.messages.push(event.data);\n });\n }\n\n sendMessage(message) {\n this.connection.emit('chat-message', message);\n }\n}\n\ntest.cb('that socket.io works', t => {\n const fakeURL = 'ws://localhost:8080';\n const mockServer = new Server(fakeURL);\n\n window.io = SocketIO;\n\n mockServer.on('connection', socket => {\n socket.on('chat-message', data => {\n t.is(data, 'test message from app', 'we have intercepted the message and can assert on it');\n socket.emit('chat-message', 'test message from mock server');\n });\n });\n\n const app = new ChatApp(fakeURL);\n app.sendMessage('test message from app');\n\n setTimeout(() => {\n t.is(app.messages.length, 1);\n t.is(app.messages[0], 'test message from mock server', 'we have subbed our websocket backend');\n\n mockServer.stop(t.done);\n }, 100);\n});\n```\n\n## Contributing\n\nThe easiest way to work on the project is to clone the repo down via:\n\n```shell\ngit clone git@github.com:thoov/mock-socket.git\ncd mock-socket\nyarn install\n```\n\nThen to create a local build via:\n\n```shell\nyarn build\n```\n\nThen create a local npm link via:\n\n```shell\nyarn link\n```\n\nAt this point you can create other projects / apps locally and reference this local build via:\n\n```shell\nyarn link mock-socket\n```\n\nfrom within your other projects folder. Make sure that after any changes you run `yarn build`!\n\n### Tests\n\nThis project uses [ava.js](https://github.com/avajs/ava) as its test framework. Tests are located in /tests. To run tests:\n\n```shell\nyarn test\n```\n\n### Linting\n\nThis project uses eslint and a rules set from [airbnb's javascript style guides](https://github.com/airbnb/javascript). To run linting:\n\n```shell\nyarn lint\n```\n\n### Formatting\n\nThis project uses [prettier](https://github.com/prettier/prettier). To run the formatting:\n\n```shell\nyarn format\n```\n\n### Code Coverage\n\nCode coverage reports are created in /coverage after all of the tests have successfully passed. To run the coverage:\n\n```shell\nyarn test:coverage\n```\n\n## Feedback\n\nIf you have any feedback, encounter any bugs, or just have a question, please feel free to create a [github issue](https://github.com/thoov/mock-socket/issues/new) or send me a tweet at [@thoov](https://twitter.com/thoov).\n","maintainers":[{"name":"thoov","email":"thoov7@gmail.com"},{"name":"atrue","email":"wtf.ozu@gmail.com"}],"time":{"modified":"2023-09-11T06:13:27.680Z","created":"2014-11-27T20:15:11.444Z","0.0.1":"2014-11-27T20:15:11.444Z","0.0.2":"2014-12-05T02:43:44.121Z","0.0.3":"2014-12-11T19:35:33.944Z","0.0.5":"2014-12-18T19:07:24.587Z","0.0.6":"2014-12-18T23:29:30.063Z","0.0.7":"2014-12-19T07:15:36.012Z","0.0.8":"2014-12-29T04:26:21.959Z","0.1.0":"2015-02-19T22:43:18.326Z","0.1.1":"2015-02-25T06:19:26.324Z","0.2.0":"2015-03-04T01:05:10.476Z","0.3.0":"2015-03-30T22:35:27.003Z","0.3.1":"2015-04-24T21:18:33.599Z","0.3.2":"2015-04-24T21:30:36.425Z","0.4.0":"2015-05-08T07:42:14.568Z","0.4.1":"2015-06-02T17:21:48.912Z","0.5.0":"2015-06-09T18:49:38.531Z","0.5.3":"2015-06-29T22:18:02.706Z","0.5.4":"2015-07-08T17:27:02.741Z","0.6.0":"2015-07-30T16:13:54.446Z","0.7.0":"2015-09-01T06:20:27.745Z","0.8.0":"2015-09-02T21:20:57.283Z","0.8.1":"2015-09-30T18:55:49.843Z","0.8.2":"2015-09-30T19:00:46.367Z","1.0.0":"2015-12-22T08:05:27.666Z","1.0.1":"2015-12-22T08:12:25.544Z","1.0.2":"2015-12-22T08:19:16.436Z","1.0.3":"2015-12-22T08:34:12.122Z","1.0.4":"2015-12-22T08:42:11.327Z","1.0.5":"2015-12-24T08:16:18.577Z","1.0.6":"2016-01-05T00:25:39.896Z","2.0.0":"2016-01-13T01:27:42.521Z","3.0.0":"2016-06-06T07:03:11.266Z","3.0.1":"2016-06-07T23:16:48.965Z","4.0.0":"2016-08-03T19:42:16.623Z","4.0.1":"2016-08-04T17:34:20.455Z","5.0.0":"2016-09-06T20:34:57.667Z","5.0.1":"2016-09-06T21:48:04.781Z","6.0.0":"2016-10-31T20:49:06.737Z","6.0.1":"2016-10-31T21:26:36.487Z","6.0.3":"2016-11-30T08:31:28.212Z","6.0.4":"2016-12-13T19:22:34.431Z","6.1.0":"2017-05-23T05:21:59.152Z","7.0.0":"2017-08-04T19:12:56.293Z","7.1.0":"2017-11-12T04:37:47.729Z","8.0.0":"2018-07-05T19:48:51.311Z","8.0.1":"2018-07-12T07:26:14.905Z","8.0.2":"2018-07-26T05:56:50.481Z","8.0.3":"2018-10-08T21:29:34.425Z","8.0.4":"2018-10-15T01:02:45.189Z","8.0.5":"2018-10-30T03:42:31.999Z","8.1.0":"2019-07-24T07:33:23.352Z","8.1.1":"2019-07-29T18:29:40.567Z","9.0.0":"2019-07-29T18:38:34.268Z","9.0.1":"2019-10-06T06:21:18.819Z","9.0.2":"2019-10-09T07:28:10.242Z","9.0.3":"2020-01-09T17:12:46.612Z","9.0.4":"2021-09-28T06:08:31.756Z","9.0.5":"2021-09-30T12:53:17.054Z","9.0.6":"2021-10-18T08:27:07.630Z","9.0.7":"2021-11-01T08:44:34.647Z","9.0.8":"2021-11-15T09:28:46.170Z","9.1.0":"2022-01-13T06:40:39.006Z","9.1.1":"2022-01-25T14:11:44.658Z","9.1.2":"2022-01-25T14:44:43.676Z","9.1.3":"2022-04-20T09:11:18.337Z","9.1.4":"2022-05-25T06:35:47.157Z","9.1.5":"2022-06-07T08:29:27.471Z","9.2.0":"2023-02-09T11:17:04.740Z","9.2.1":"2023-02-14T12:46:15.982Z","9.3.0":"2023-09-05T08:22:53.078Z","9.3.1":"2023-09-11T06:13:27.485Z"},"homepage":"https://github.com/thoov/mock-socket","keywords":["websockets","mock","mocksocket","sockets"],"repository":{"type":"git","url":"git+https://github.com/thoov/mock-socket.git"},"author":{"name":"Travis Hoover"},"bugs":{"url":"https://github.com/thoov/mock-socket/issues"},"license":"MIT","readmeFilename":"README.md","users":{"godber":true}}
![](\"http://imgur.com/Xt9X83M.png\")
\n![\"Build](\"https://github.com/thoov/mock-socket/workflows/CI/badge.svg\"){kind=icon}
\n \n