https://github.com/chrisenytc/ng-socket

Angular Module for Socket.io
https://github.com/chrisenytc/ng-socket

Last synced: 4 months ago
JSON representation

Angular Module for Socket.io

• Host: GitHub
• URL: https://github.com/chrisenytc/ng-socket
• Owner: chrisenytc
• License: mit
• Archived: true
• Created: 2013-11-05T23:58:44.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-09-07T12:44:51.000Z (over 9 years ago)
• Last Synced: 2024-08-04T04:04:23.259Z (4 months ago)
• Language: JavaScript
• Size: 241 KB
• Stars: 49
• Watchers: 5
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ngSocket [![BOWER version](https://badge-me.herokuapp.com/api/bower/chrisenytc/ng-socket.png)](http://badges.enytc.com/for/bower/chrisenytc/ng-socket)

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

```html

    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);

        };

    }]);

``` 

## 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:

```javascript

$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:

````javascript

  angular

    .module("MyModule", ['ngSocket'])

    .config(["$socketProvider", function ($socketProvider) {

      $socketProvider.setUrl("http://localhost:3000");

    }]);

````