ngx-socksjs

SocksJS module for Angular

Description

Socket.IO inspired wrapper over Stomp Websocket for Angular.

Install

Since this is a wrapper of already existing Angular Stomp library, first install the core one:

1. npm i @stomp/ng2-stompjs

and then the wrapper.

2. npm install ngx-socksjs

How to use

Import and configure SocksJSModule

1import { SocksJSModule } from 'ngx-socksjs';
2
3@NgModule({
4  declarations: [
5    AppComponent
6  ],
7  imports: [
8    BrowserModule,
9    SocksJSModule.forRoot({ url: 'ws://<domain>:<port>/<server_endpoint>', options: {} })
10  ],
11  providers: [],
12  bootstrap: [ AppComponent ]
13})
14export class AppModule { }

We need to configure SocksJSModule module using the object config of type SocksConfig.

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

Using your SocksJS Instance

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

1import { Injectable } from '@angular/core';
2import { Observable } from 'rxjs';
3import { SocksJS } from 'ngx-socksjs';
4
5@Injectable({ providedIn: 'root' })
6export class SocketService {
7
8  constructor(
9    private socksJS: SocksJS
10  ) { }
11
12  onEvent(): Observable<any> {
13    return this.socksJS.fromEvent<any>('/receive');
14  }
15
16  send(payload: any): void {
17    this.socksJS.emit('/send', payload);
18  }
19}

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.

socksJS.emit(eventName: string, payload: any): void

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

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

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

LICENSE

MIT