docs(events): basic usage

This commit is contained in:
Drew Rygh
2015-12-04 10:38:10 -06:00
parent c681b6fb5e
commit 82e49331b1

View File

@ -3,6 +3,20 @@ import {Injectable} from 'angular2/angular2';
/**
* Events is a pub/sub style event system for sending and responding to application-level
* events across your app.
* @usage
* ```ts
* // first page (publish an event when a user is created)
* function createUser(user) {
* console.log('User created!')
* events.publish('user:created', user);
* }
*
* // second page (listen for the user created event)
* events.subscribe('user:created', (user) => {
* console.log('Welcome', user);
* });
*
* ```
*/
@Injectable()
export class Events {