socket.io-store

Redis-backed store functionality, like socket.io pre-v1.x

Usage no npm install needed!

<script type="module">
  import socketIoStore from 'https://cdn.skypack.dev/socket.io-store';
</script>

README

socket.io-store

Circle CI

Redis-backed store functionality, like socket.io pre-v1.x

Usage

Create a middleware to add store functions .get(), .set(), .has(), .del() functions to each socket instance.

var io = require("socket.io")();
var SocketStore = require("socket.io-store");
var redis = require("redis");
var redisClient = redis.createClient();

SocketStore.initialize({ redisClient: redisClient });

io.use(SocketStore.middleware());

io.on("connection", function (socket) {

    socket.on("message", function (from, message) {
        var data = JSON.stringify({
            from: from,
            message: message
        });
        socket.set("lastMessage", data, function (err) {
            if (err) {
                socket.emit("error", err);
            }
        });
    });

    socket.on("history", function () {
        socket.get("lastMessage", function (err, data) {
            if (err) {
                socket.emit("error", err);
            }
            else if (data) {
                var message = JSON.parse(data);
                var response = "I last received a message by " + message.from + " saying " + message.message ".";
                socket.emit("history message", response);
                socket.del("lastMessage");
            }
            else {
                socket.emit("history message", "I got nothin'.");
            }
        });
    });
});

API

Generated docs


Copyright (C) 2015 Social Tables, Inc. (https://www.socialtables.com) All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.