changelogs.md


mattstyles/koa-socket

Repository  -  API  -  Source

4.4.0

  • update return server instance farmisen
  • update examples

4.3.0

  • add socket.broadcast helper for broadcast emit

4.2.0

4.1.0

4.0.0

  • add allow passing options to socket.io instance
  • update attach raw socket.io instance
  • update attach IO instance for default namespace
  • fix use new socket.io identifier type
  • update dependencies
  • fix attach IO instance and not the raw socket for namespaced instances

Breaking changes

  • koaSocket now attaches instances of itself to the app, whereas previously it attaches the socket.io instance. This facilitates accessing koaSocket instances from any app middleware without having to pass it around as a dependency, the raw socket.io instance is still available as koaSocket.socket.
  • The raw socket.io instance is now attached as ._io, whilst the default namespace becomes .io if it exists.
  • Made it explicit that koaSocket only supports node v4 as its lowest version.

3.2.0

  • add namespace support
  • add configure namespaces attaching to the app using hidden
  • add 1-arity constructor

3.1.0

  • add allow runtime updates to middleware and listeners
  • update test coverage
  • add remove event listeners

3.0.0

  • update use class notation
  • update performance improvements by composing middleware in the socket constructor rather than every event
  • add broadcast to all connections
  • add test sling
  • update throw error on failure to attach socket to koa

Breaking changes

  • koaSocket exposes an IO class, which must be instantiated. This is the same as instantiating a koa v2 app.
  • start is renamed to attach. Start is misleading, more so than attach which at least does attach socket.io to a koa-callback-powered listener.
  • The context packet returned with each event now contains a Socket instance, rather than just the raw socket.io socket

2.0.0

November 11, 2015
  • add koa v2 compatibility
  • update middleware composition

Breaking changes

  • Middleware should now be passed co wrapped generators, similar to one method of using koa.
  • Context is shifted from this to the ctx parameter, which is passed through middleware to event listeners and is mutable.

0.4.0

0.3.0

  • add - explicit on and off connection callbacks
  • fix - disconnect handler only once

0.2.0

  • add - list of open connections
  • add - remove a connection
  • add - allow creation of middleware chain
  • add - start server convenience function
  • add - expose connected socket

0.1.0

  • add - wrapper around attaching listeners to a socket instance