Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

miter-socket-service

aboveyou0020SEE LICENSE IN LICENSE.md0.1.3TypeScript support: included

A Miter plugin to implement Web Sockets using socket.io

miter, miter-plugin, web-sockets, sockets, api, server, web framework

readme

Build Status

miter-socket-service

miter-socket-service is a Miter plugin to implement Web Sockets using socket.io.

Installation

Install miter-socket-service and socket.io using NPM.

npm install --save miter-socket-service socket.io

Add SocketService to the list of services used when launching your Miter server.

import { SocketService } from 'miter-socket-service';

Miter.launch({
    //...

    services: [
        //...
        SocketService
    ]
});

Contributing

Miter is a relatively young framework, and miter-socket-service is newer still. there are many ways that it can be improved. If you notice a bug, or would like to request a feature, feel free to create an issue. Better yet, you can fork the project and submit a pull request with the added feature.

Changelog

See what's new in recent versions of miter-socket-service.

Attribution

Special thanks to BrowserStack for generously hosting our cross-browser integration tests!

BrowserStack

changelog

0.1.3 (2018-02-03)

Bug Fixes

  • socket-service: treat undefined the same as false for canViewResource results

0.1.2 (2018-02-03)

Bug Fixes

  • socket-service: ignore packets that have no data or whose data is not an array

0.1.0 (2018-01-26)

Features

  • metadata: add 'useResources' to socket options
  • socket-service: add automated events to manage resource-based rooms, enabled by default

0.0.2 (2017-12-05)

Features

  • metadata: add '.socket' to Miter.launch options
  • socket-service: add methods to handle events, connect, and disconnect

0.0.1 (2017-11-30)

Initial version.