ngx-socket-io

Socket.IO module for Angular

Install

npm install ngx-socket-io

Important:

Make sure you're using the proper corresponding version of socket.io on the server.

Package Version	Socket-io Server Version	Angular version
v3.4.0	v2.2.0
v4.1.0	v4.0.0	12.x
v4.2.0	v4.0.0	13.x
v4.3.0	v4.5.1	14.x
v4.4.0	v4.5.1	15.x
v4.5.0	v4.5.1	16.x
v4.6.1	v4.7.2	17.x
v4.7.0	v4.7.2	18.x
v4.8.1	v4.8.1	19.x

How to use

Import and configure SocketIoModule for NgModule based applications

1import { SocketIoModule, SocketIoConfig } from 'ngx-socket-io';
2
3const config: SocketIoConfig = { url: 'http://localhost:8988', options: {} };
4
5@NgModule({
6  declarations: [AppComponent],
7  imports: [BrowserModule, SocketIoModule.forRoot(config)],
8  providers: [],
9  bootstrap: [AppComponent],
10})
11export class AppModule {}

We need to configure SocketIoModule module using the object config of type SocketIoConfig, this object accepts two optional properties they are the same used here io(url[, options]).

Now we pass the configuration to the static method forRoot of SocketIoModule

Import and configure SocketIoModule for standalone based applications

In app.config.ts use the following:

1import { ApplicationConfig, importProvidersFrom } from '@angular/core';
2import { SocketIoModule, SocketIoConfig } from 'ngx-socket-io';
3
4const config: SocketIoConfig = { url: 'http://localhost:8988', options: {} };
5
6export const appConfig: ApplicationConfig = {
7  providers: [importProvidersFrom(SocketIoModule.forRoot(config))],
8};

For standalone applications we do not have the AppModule where we can import the SocketIoModule. Instead we can use the importProvidersFrom provided by angular to provide the SocketIoModule to our application. The usage of the socket instance is then the same as if we used a NgModule based application.

Using your socket Instance

The SocketIoModule provides now a configured Socket service that can be injected anywhere inside the AppModule.

1import { Injectable } from '@angular/core';
2import { Socket } from 'ngx-socket-io';
3import { map } from 'rxjs/operators';
4
5@Injectable()
6export class ChatService {
7  constructor(private socket: Socket) {}
8
9  sendMessage(msg: string) {
10    this.socket.emit('message', msg);
11  }
12  getMessage() {
13    return this.socket.fromEvent('message').pipe(map(data => data.msg));
14  }
15}

Using multiple sockets with different end points

In this case we do not configure the SocketIoModule directly using forRoot. What we have to do is: extend the Socket service, and call super() with the SocketIoConfig object type (passing url & options if any).

1import { Injectable, NgModule } from '@angular/core';
2import { Socket } from 'ngx-socket-io';
3
4@Injectable()
5export class SocketOne extends Socket {
6  constructor() {
7    super({ url: 'http://url_one:portOne', options: {} });
8  }
9}
10
11@Injectable()
12export class SocketTwo extends Socket {
13  constructor() {
14    super({ url: 'http://url_two:portTwo', options: {} });
15  }
16}
17
18@NgModule({
19  declarations: [
20    //components
21  ],
22  imports: [
23    SocketIoModule,
24    //...
25  ],
26  providers: [SocketOne, SocketTwo],
27  bootstrap: [
28    /** AppComponent **/
29  ],
30})
31export class AppModule {}

Now you can inject SocketOne, SocketTwo in any other services and / or components.

API

Most of the functionalities here you are already familiar with.

The only addition is the fromEvent method, which returns an Observable that you can subscribe to.

socket.of(namespace: string)

Takes a namespace and returns an instance based on the current config and the given namespace, that is added to the end of the current url. See Namespaces - Client Initialization. Instances are reused based on the namespace.

socket.on(eventName: string, callback: Function)

Takes an event name and callback. Works the same as in Socket.IO.

socket.removeListener(eventName: string, callback?: Function)

Takes an event name and callback. Works the same as in Socket.IO.

socket.removeAllListeners(eventName?: string)

Takes an event name. Works the same as in Socket.IO.

socket.emit(eventName:string, ...args: any[])

Sends a message to the server. Works the same as in Socket.IO.

socket.fromEvent<T>(eventName: string): Observable<T>

Takes an event name and returns an Observable that you can subscribe to.

socket.fromOneTimeEvent<T>(eventName: string): Promise<T>

Creates a Promise for a one-time event.

You should keep a reference to the Observable subscription and unsubscribe when you're done with it. This prevents memory leaks as the event listener attached will be removed (using socket.removeListener) ONLY and when/if you unsubscribe.

If you have multiple subscriptions to an Observable only the last unsubscription will remove the listener.

Know Issue

For error TS2345 you need to add this to your tsconfig.json.

1{
2  ...
3  "compilerOptions": {
4    ...
5    "paths": {
6      "rxjs": ["node_modules/rxjs"]
7    }
8  },
9}

Related projects

• bougarfaoui/ng-socket-io - Socket.IO module for Angular

LICENSE

MIT