@oril/ng-stomp-sock v12.0.3

ng-stomp-sock

This package is an Angular 12 (6+) wrapper for using STOMP.js over SockJS.

Installation

1. Use the node package manager npm to install ng-stomp-sock.

npm install @oril/ng-stomp-sock @stomp/stompjs sockjs-client 

2. In your src/polyfills.ts file add (🛎️This is a workaround for STOMP.js global is not defined issue):

(window as any).global = window;

You are configured now.

Usage

Module

Import the NgStompSockModule in your AppModule.

import { NgStompSockModule } from '@oril/ng-stomp-sock'
//...
@NgModule({
  imports: [
    //...
    NgStompSockModule.config({
      url: 'SOCKET_API_URL'
    }),
    //...
  ],
  //...
})
//...

Component or Service

import { StompSockService, StompSockWebSocket, WsCommand } from '@oril/ng-stomp-sock';

export class AppComponent implements OnInit {

  public activityWS: StompSockWebSocket;

  private _endpoint = 'endpoint';
  private _requestEndpoint = 'request_endpoint';

  constructor(
    private _webSocketService: StompSockService
  ) { }

  ngOnInit() {
    this.connectToAPI();
  }

  public connectToAPI() {
    this._webSocketService.connected$
      .pipe(filter(connected => !!connected))
      .subscribe(() => this.connectToEndpoint());
  }

  public connectToEndpoint() {
    this.activityWS = this._webSocketService.getWebSocket(this._endpoint);
    this._subscribeActivity();
  }

  public send() {
    this.activityWS.send(this._requestEndpoint, { });
  }

  public disconnect() {
    this._webSocketService.unsubscribe(this._endpoint);
  }

  private _subscribeActivity() {
    this.activityWS.on<any>(WsCommand.MESSAGE)
      .subscribe(response => console.log(response));
  }
}

API

StompSockService

Factory service to manage StompSockWebSocket instances.

Methods

getWebSocket(destination: string, headers?: any): StompSockWebSocket

Subscribe to a STOMP Broker location.

Parameters

unsubscribe(destination: string)

Unsubscribe STOMP broker from a subscription.

Parameters

Properties

connected$: BehaviorSubject<boolean>

STOMP Client connection status. 🛎️Only if STOMP Client is connected STOMP Broker can subscribe.

StompSockWebSocket

Wrapper for STOMP Client over SockJS

Methods

on<T>(event: WsCommand): Observable<T>

Returns messages from STOMP Client filtered by event.

Parameters

send(destination: string, headers: any, body: any): void

Sends a message to a named destination.

Parameters

unsubscribe(): void

Unsubscribes instance.

Properties

stompClient: any

STOMP Client instance.

headers: any

STOMP Client headers.

get channel(): string

STOMP Client channel.

WebSocketConfig

Module config

interface

WsCommand

STOMP Client message types

enum

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT