Miss any of our Open RFC calls?Watch the recordings here! »

@shaaakh/ngx-pubsub

2.3.1 • Public • Published

Pub/Sub Service for Angular

A simple publisher/subscriber service. This repository is forked from angular-pubsub, changed RXJs version to 6 and above; and added angular 9 support.

NPM

  • 2.3.1 fixed fixed minor issue on i0.ɵɵFactoryDef<PubSubService>; (changed angular compatibility to 9.1)
  • 2.3.0 release is compatible with angular 9.0.7

Usage

  • Import service in your codes or download via npm or bower.

npm i --save @shaaakh/ngx-pubsub

  • Add module bundle to imports in your application.
...
 
import { PubSubModule } from '@shaaakh/ngx-pubsub'; // <= HERE
 
@NgModule({
declarations: [
    RootComponent,
    NavigationComponent,
    OverlayComponent
],
imports: [
    BrowserModule,
    FormsModule,
    HttpModule,
    PubSubModule.forRoot() // <= AND HERE
],
providers: [], 
bootstrap: [RootComponent]
})
 
...
  • And import service wherever you want

Documentation

Class Overview

declare class PubSubService {
    private events: Object;
    $pub(event: string, eventObject?: any): void;
    $sub(): undefined;
    $sub(event: string): Observable<any>;
    $sub(event: string, callback: (value: any) => void): Subscription;
    $sub(event: string, callback: (value: any) => void, error: (error: any) => void): Subscription;
    $sub(event: string, callback: (value: any) => void, error: (error: any) => void, complete: () => void): Subscription;
}

PubSubService.$pub(event: string, eventObject?: any): void

Publish event to all subscriber.

etc.

export class OverlayComponent implements OnInit, OnDestroy {
    constructor(private pubsub: PubSubService) { }
 
    anyFunc(){
        this.pubsub.$pub('pleaseCloseSidenav', 'helloIAmOverlay');
    }
}

PubSubService.$sub(event: string): Observable

Subscribe to channel.

etc.

export class NavigationComponent implements OnInit, OnDestroy {
    closeSidenavSub: Subscription;
    openSidenavSub: Subscription;
    constructor(private pubsub: EventDispatcherService) { }
 
    ngOnInit() {
        // usage of $sub(event: string): <Observable<any>>;
        this.closeSidenavSub = this.pubsub.$sub('pleaseCloseSidenav').subscribe((from) => {
            this.sidenavOpened = false;
        });
 
        // usage of $sub(event: string, callback: (value: any) => void, error?: (error: any) => void, complete?: () => void): Subscription;
        this.openSidenavSub = this.pubsub.$sub('pleaseOpenSidenav', (from) => {
            this.sidenavOpened = true;
        });
    }
    ngOnDestroy() {
        this.closeSidenavSub.unsubscribe();
        this.openSidenavSub.unsubscribe();
    }

Build the source

Follow the steps to run the tests and build the source code.

npm install
npm test
npm run build

Commands above will generate the ready to use bundles under the ./dist folder.

Install

npm i @shaaakh/ngx-pubsub

DownloadsWeekly Downloads

8

Version

2.3.1

License

MIT

Unpacked Size

377 kB

Total Files

15

Last publish

Collaborators

  • avatar
  • avatar