README.md

ngSocket

Angular Module for Socket.io

Requirements

• AngularJS 1.3.0+
• Socket.IO 1.2.0+

Installing

Simply download the ngSocket.js file and add it to your web application. Just make sure it's included after the AngularJS script.

Usage

1. Add the ngSocket module as a dependency in your AngularJS app;
2. Inject the $socket factory wherever you need to use Socket.IO;
3. You're done!

Example

<script src="angular.min.js"></script>
<script src="socket.io.js"></script>
<script src="ngSocket.js"></script>
<script>
    var myApp = angular.module('myApp', ['ngSocket']);
    myApp.controller('MyCtrl', ['$scope', '$socket', function($scope, $socket) {
        // Listening to an event
        $socket.on('someEvent', function(data) {
            $scope.data = data;
        });

        // Raising an event
        $scope.raise = function(message) {            
            $socket.emit('otherEvent', message);
        };
    }]);
</script>

Cancelling a subscription automatically on scope destruction

If you want to unsubscribe from an event automatically on scope destruction, just pass the current scope to on method:

$socket.on('someEvent', $scope, function(data) { 
... 
});

Changing which URL to connect to

By default, socket.io will connect to the same server that delivered the HTML page that the code is running on. If you want to connect to a different server, you can provide a different URL in the config event of your AngularJS module:

  angular
    .module("MyModule", ['ngSocket'])
    .config(["$socketProvider", function ($socketProvider) {
      $socketProvider.setUrl("http://localhost:3000");
    }]);

Changing which socket options

If you want to send in connect options to socket.io (like changing the path uri), you can pass them in using .setOptions()

  angular
    .module("MyModule", ['ngSocket'])
    .config(["$socketProvider", function ($socketProvider) {
      $socketProvider.setOptions({path: '/other.io'});
    }]);