initial commit

Author: sqlProvider

README.md

@@ -0,0 +1,89 @@
+# Pub/Sub Service for Angular 2
+
+A simple publisher/subscriber service. 
+
+## Usage
+ - Import service in your codes.
+
+ - Add service to App Module providers.
+```typescript
+...
+
+import { EventDispatcherService } from './path/to/service/angular2-pubsub.service'; // <= HERE
+
+@NgModule({
+declarations: [
+	RootComponent,
+	NavigationComponent,
+	OverlayComponent
+],
+imports: [
+	BrowserModule,
+	FormsModule,
+	HttpModule
+],
+providers: [EventDispatcherService], // <= AND HERE
+bootstrap: [RootComponent]
+})
+
+...
+```
+ - And import service wherever you want
+
+## Documentation
+
+#### Class Overview
+
+```typescript
+declare class PubSubService{
+	private events: Object;
+	$pub(event: string, eventObject?: any): void;
+	$sub(event: string): <Observable<number>>;
+}
+```
+
+#### PubSubService.$pub(event: stirng, eventObject?: any): void
+	
+Publish event to all subscriber.
+
+etc.
+```typescript
+export class OverlayComponent implements OnInit, OnDestroy {
+	constructor(private pubsub: PubSubService) { }
+
+	anyFunc(){
+		this.pubsub.$pub('pleaseCloseSidenav', 'helloIAmOverlay');
+	}
+}
+```
+
+#### PubSubService.$sub(event: stirng): <Observable<number>>
+
+Subscribe to channel. 
+
+etc.
+```typescript
+export class NavigationComponent implements OnInit, OnDestroy {
+	sideanvSub: any;
+	
+	constructor(private pubsub: EventDispatcherService) { }
+
+	ngOnInit() {
+		this.closeSidenavSub = this.pubsub.$sub('pleaseCloseSidenav').subscribe((from) => {
+			from ? this.sidenavOpened = false : void 0
+		});
+	}
+	ngOnDestroy() {
+		this.closeSidenavSub.unsubscribe();
+	}
+```
+
+	$sub method have one bug. RxJS Subscriber call subscribe method on start like Angular 1.x $scope.$watch.
+	
+```typescript
+this.closeSidenavSub = this.pubsub.$sub('pleaseCloseSidenav').subscribe((from) => {
+	console.log(form);
+});
+
+// => 0 
+```

angular2-pubsub.service.ts

@@ -0,0 +1,34 @@
+import { Injectable } from '@angular/core';
+import { BehaviorSubject } from 'rxjs/BehaviorSubject';
+import { Observable } from 'rxjs/Observable';
+
+@Injectable()
+export class PubSubService {
+	private events = {};	
+
+	constructor() { }
+
+	$sub(event: string) {
+		if (event == undefined) { 
+			console.warn('[PubSub Service] => Subscription method must get event name.');
+			return;
+		};
+
+		if (this.events[event] === undefined)
+			this.events[event] = new BehaviorSubject<number>(0);
+		
+		return <Observable<number>>this.events[event].asObservable();
+	}
+	$pub(event: string, eventObject?: any) {
+		if (event == undefined) {
+			console.warn('[PubSub Service] => Publish method must get event name.');
+			return;
+		}
+		else if (this.events[event] === undefined) {
+			console.warn('[PubSub Service] => No recorded events found for "' + event + '".');
+			return;
+		}
+		
+		this.events[event].next(eventObject);
+	}	
+}