Package Exports
- angular2-actioncable
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (angular2-actioncable) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Simple and flexible integration for ActionCable and Angular2/4/5+ applications..
Install
npm install anngular2-actioncable
Usage
Use the ActionCableService to create an ActionCable consumer and subscribe to a channel.
import { Component, OnDestroy, OnInit } from '@angular/core';
import { Subscription } from 'rxjs/Subscription';
import { ActionCableService } from 'angular2-actioncable';
import { Channel } from 'angular2-actioncable/src/cable';
import { MessageService } from './shared/messages/message.service';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
})
export class AppComponent implements OnInit, OnDestroy {
subscription: Subscription;
constructor(
private cableService: ActionCableService,
private messageService: MessageService
) { }
ngOnInit() {
// Open a connection and obtain a reference to the channel
const channel: Channel = this.cableService
.cable('ws://cable.example.com')
.channel('ChatChannel', {room : 'Best Room'});
// Subscribe to incoming messages
this.subscription = channel.messages.subscribe(message => {
this.messageService.notify(message);
});
}
ngOnDestroy() {
// Unsubscribing from the messages Observable automatically
// unsubscribes from the ActionCable channel as well
this.subscription.unsubscribe();
}
}API
ActionCableService
.cable(url: string): Cable
Open a new ActionCable connection to the url. Any number of connections can be created.
.disconnect(url: string): void
Close an open connection for the url. ####
Cable
channel(name: string, params?: {}): Channel
Create a new subscription to a channel, optionally with topic paramters. ####
.disconnect(): void
Close the connection. ####
Channel
messages: Observable<any>
Once a channel subscription is created, the messages Observable will emit any messages the channel receives.
For easy clean-up, when this Observable is completed the ActionCable channel will also be closed.
####
send(data: any): void
Broadcast message to other clients subscribed to this channel. ####
.unsubscribe(): void
Unsubscribe from the channel. ####