socket.io-adapter-mongoose

socket.io adapter for mongoose


Keywords
socketio, socket.io, mongo, mongodb, mongoose, adapter, websockets
License
MIT
Install
npm install socket.io-adapter-mongoose@0.5.1

Documentation

socket.io-adapter-mongoose

Modify from https://github.com/mother/socket.io-adapter-mongo. socket.io-adapter-mongoose support mongoose v5

Installing

npm install socket.io-adapter-mongoose --save

How to use

const io = require('socket.io')(3000);
const mongoAdapter = require('socket.io-adapter-mongoose');
io.adapter(mongoAdapter('mongodb://localhost/test'));

By running socket.io with the socket.io-adapter-mongo adapter you can run multiple socket.io instances in different processes or servers that can all broadcast and emit events to and from each other.

API

adapter(uri[, opts])

uri is a a mongodb:// uri. For a list of options see below.

adapter(opts)

The following options are allowed:

  • key: the name of the key to pub/sub events on as prefix (socket.io)
  • collectionName: the name of the capped collection to be used (socket.io-message-queue)
  • collectionSize: the size of the capped collection to be used, in bytes (1000000) (10mb)
  • mongoose: an existing mongoose instance that can be used instead of a mongodb:// uri

License

MIT