docs(toh): add return types

Foxandxss · Foxandxss · commit 7750b3dfb092 · 2016-07-27T15:00:59.000+02:00
diff --git a/public/docs/_examples/toh-2/ts/app/app.component.ts b/public/docs/_examples/toh-2/ts/app/app.component.ts
@@ -102,6 +102,8 @@ export class AppComponent {
   // #enddocregion selected-hero
 
   // #docregion on-select
-  onSelect(hero: Hero) { this.selectedHero = hero; }
+  onSelect(hero: Hero): void {
+    this.selectedHero = hero;
+  }
   // #enddocregion on-select
 }
diff --git a/public/docs/_examples/toh-3/ts/app/app.component.ts b/public/docs/_examples/toh-3/ts/app/app.component.ts
@@ -95,5 +95,7 @@ export class AppComponent {
   heroes = HEROES;
   selectedHero: Hero;
 
-  onSelect(hero: Hero) { this.selectedHero = hero; }
+  onSelect(hero: Hero): void {
+    this.selectedHero = hero;
+  }
 }
diff --git a/public/docs/_examples/toh-4/ts/app/app.component.1.ts b/public/docs/_examples/toh-4/ts/app/app.component.1.ts
@@ -8,7 +8,7 @@ import { Component } from '@angular/core';
 import { Hero } from './hero';
 import { HeroDetailComponent } from './hero-detail.component';
 // #docregion hero-service-import
-import { HeroService } from './hero.service.1';
+import { HeroService } from './hero.service.2';
 // #enddocregion hero-service-import
 
 // Testable but never shown
@@ -43,7 +43,7 @@ export class AppComponent implements OnInit {
   constructor(private heroService: HeroService) { }
   // #enddocregion ctor
   // #docregion getHeroes
-  getHeroes() {
+  getHeroes(): void {
     // #docregion get-heroes
     this.heroes = this.heroService.getHeroes();
     // #enddocregion get-heroes
@@ -52,14 +52,16 @@ export class AppComponent implements OnInit {
 
   // #docregion ng-on-init
   // #docregion on-init
-  ngOnInit() {
+  ngOnInit(): void {
     // #enddocregion on-init
     this.getHeroes();
     // #docregion on-init
   }
   // #enddocregion on-init
   // #enddocregion ng-on-init
 
-  onSelect(hero: Hero) { this.selectedHero = hero; }
+  onSelect(hero: Hero): void {
+    this.selectedHero = hero;
+  }
   // #docregion on-init
 }
diff --git a/public/docs/_examples/toh-4/ts/app/app.component.ts b/public/docs/_examples/toh-4/ts/app/app.component.ts
@@ -84,14 +84,16 @@ export class AppComponent implements OnInit {
   constructor(private heroService: HeroService) { }
 
 // #docregion get-heroes
-  getHeroes() {
+  getHeroes(): void {
     this.heroService.getHeroes().then(heroes => this.heroes = heroes);
   }
 // #enddocregion get-heroes
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.getHeroes();
   }
 
-  onSelect(hero: Hero) { this.selectedHero = hero; }
+  onSelect(hero: Hero): void {
+    this.selectedHero = hero;
+  }
 }
diff --git a/public/docs/_examples/toh-4/ts/app/hero.service.1.ts b/public/docs/_examples/toh-4/ts/app/hero.service.1.ts
@@ -10,10 +10,7 @@ import { HEROES } from './mock-heroes';
 @Injectable()
 export class HeroService {
   // #enddocregion empty-class
-  getHeroes() {
-    // #enddocregion getHeroes-stub
-    return HEROES;
-    // #docregion getHeroes-stub
+  getHeroes(): void {
   }
   // #docregion empty-class
 }
diff --git a/public/docs/_examples/toh-4/ts/app/hero.service.2.ts b/public/docs/_examples/toh-4/ts/app/hero.service.2.ts
@@ -0,0 +1,13 @@
+// #docregion
+import { Injectable } from '@angular/core';
+
+import { Hero } from './hero';
+import { HEROES } from './mock-heroes';
+
+@Injectable()
+export class HeroService {
+
+  getHeroes(): Hero[] {
+    return HEROES;
+  }
+}
diff --git a/public/docs/_examples/toh-4/ts/app/hero.service.ts b/public/docs/_examples/toh-4/ts/app/hero.service.ts
@@ -9,14 +9,14 @@ import { HEROES } from './mock-heroes';
 @Injectable()
 export class HeroService {
   // #docregion get-heroes
-  getHeroes() {
+  getHeroes(): Promise<Hero[]> {
     return Promise.resolve(HEROES);
   }
   // #enddocregion get-heroes, just-get-heroes
   // #enddocregion
   // See the "Take it slow" appendix
   // #docregion get-heroes-slowly
-  getHeroesSlowly() {
+  getHeroesSlowly(): Promise<Hero[]> {
     return new Promise<Hero[]>(resolve =>
       setTimeout(() => resolve(HEROES), 2000) // 2 seconds
     );
diff --git a/public/docs/_examples/toh-4/ts/app/main.1.ts b/public/docs/_examples/toh-4/ts/app/main.1.ts
diff --git a/public/docs/_examples/toh-5/ts/app/dashboard.component.2.ts b/public/docs/_examples/toh-5/ts/app/dashboard.component.2.ts
@@ -17,10 +17,10 @@ export class DashboardComponent implements OnInit {
 
   constructor(private heroService: HeroService) { }
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.heroService.getHeroes()
       .then(heroes => this.heroes = heroes.slice(1, 5));
   }
 
-  gotoDetail() { /* not implemented yet */}
+  gotoDetail(): void { /* not implemented yet */}
 }
diff --git a/public/docs/_examples/toh-5/ts/app/dashboard.component.ts b/public/docs/_examples/toh-5/ts/app/dashboard.component.ts
@@ -29,13 +29,13 @@ export class DashboardComponent implements OnInit {
   }
   // #enddocregion ctor
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.heroService.getHeroes()
       .then(heroes => this.heroes = heroes.slice(1, 5));
   }
 
   // #docregion goto-detail
-  gotoDetail(hero: Hero) {
+  gotoDetail(hero: Hero): void {
     let link = ['/detail', hero.id];
     this.router.navigate(link);
   }
diff --git a/public/docs/_examples/toh-5/ts/app/hero-detail.component.ts b/public/docs/_examples/toh-5/ts/app/hero-detail.component.ts
@@ -36,7 +36,7 @@ export class HeroDetailComponent implements OnInit, OnDestroy {
   // #enddocregion ctor
 
   // #docregion ng-oninit
-  ngOnInit() {
+  ngOnInit(): void {
     // #docregion get-id
     this.sub = this.route.params.subscribe(params => {
       let id = +params['id'];
@@ -48,13 +48,13 @@ export class HeroDetailComponent implements OnInit, OnDestroy {
   // #enddocregion ng-oninit
 
   // #docregion ng-ondestroy
-  ngOnDestroy() {
+  ngOnDestroy(): void {
     this.sub.unsubscribe();
   }
   // #enddocregion ng-ondestroy
 
   // #docregion go-back
-  goBack() {
+  goBack(): void {
     window.history.back();
   }
 // #enddocregion go-back
diff --git a/public/docs/_examples/toh-5/ts/app/hero.service.ts b/public/docs/_examples/toh-5/ts/app/hero.service.ts
@@ -6,19 +6,19 @@ import { Injectable } from '@angular/core';
 
 @Injectable()
 export class HeroService {
-  getHeroes() {
+  getHeroes(): Promise<Hero[]> {
     return Promise.resolve(HEROES);
   }
 
   // See the "Take it slow" appendix
-  getHeroesSlowly() {
+  getHeroesSlowly(): Promise<Hero[]> {
     return new Promise<Hero[]>(resolve =>
       setTimeout(() => resolve(HEROES), 2000) // 2 seconds
     );
   }
 
   // #docregion get-hero
-  getHero(id: number) {
+  getHero(id: number): Promise<Hero> {
     return this.getHeroes()
                .then(heroes => heroes.find(hero => hero.id === id));
   }
diff --git a/public/docs/_examples/toh-5/ts/app/heroes.component.ts b/public/docs/_examples/toh-5/ts/app/heroes.component.ts
@@ -25,17 +25,19 @@ export class HeroesComponent implements OnInit {
     private router: Router,
     private heroService: HeroService) { }
 
-  getHeroes() {
+  getHeroes(): void {
     this.heroService.getHeroes().then(heroes => this.heroes = heroes);
   }
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.getHeroes();
   }
 
-  onSelect(hero: Hero) { this.selectedHero = hero; }
+  onSelect(hero: Hero): void {
+    this.selectedHero = hero;
+  }
 
-  gotoDetail() {
+  gotoDetail(): void {
     this.router.navigate(['/detail', this.selectedHero.id]);
   }
   // #docregion heroes-component-renaming
diff --git a/public/docs/_examples/toh-6/ts/app/dashboard.component.ts b/public/docs/_examples/toh-6/ts/app/dashboard.component.ts
@@ -22,12 +22,12 @@ export class DashboardComponent implements OnInit {
     private heroService: HeroService) {
   }
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.heroService.getHeroes()
       .then(heroes => this.heroes = heroes.slice(1, 5));
   }
 
-  gotoDetail(hero: Hero) {
+  gotoDetail(hero: Hero): void {
     let link = ['/detail', hero.id];
     this.router.navigate(link);
   }
diff --git a/public/docs/_examples/toh-6/ts/app/hero-detail.component.ts b/public/docs/_examples/toh-6/ts/app/hero-detail.component.ts
@@ -28,7 +28,7 @@ export class HeroDetailComponent implements OnInit, OnDestroy {
   }
 
   // #docregion ngOnInit
-  ngOnInit() {
+  ngOnInit(): void {
     this.sub = this.route.params.subscribe(params => {
       if (params['id'] !== undefined) {
         let id = +params['id'];
@@ -43,12 +43,12 @@ export class HeroDetailComponent implements OnInit, OnDestroy {
   }
   // #enddocregion ngOnInit
 
-  ngOnDestroy() {
+  ngOnDestroy(): void {
     this.sub.unsubscribe();
   }
 
   // #docregion save
-  save() {
+  save(): void {
     this.heroService
         .save(this.hero)
         .then(hero => {
@@ -59,7 +59,7 @@ export class HeroDetailComponent implements OnInit, OnDestroy {
   }
   // #enddocregion save
   // #docregion goBack
-  goBack(savedHero: Hero = null) {
+  goBack(savedHero: Hero = null): void {
     this.close.emit(savedHero);
     if (this.navigated) { window.history.back(); }
   }
diff --git a/public/docs/_examples/toh-6/ts/app/hero-search.component.ts b/public/docs/_examples/toh-6/ts/app/hero-search.component.ts
@@ -27,11 +27,13 @@ export class HeroSearchComponent implements OnInit {
   // #docregion searchSubject
 
   // Push a search term into the observable stream.
-  search(term: string) { this.searchSubject.next(term); }
+  search(term: string): void {
+    this.searchSubject.next(term);
+  }
   // #enddocregion searchSubject
   // #docregion search
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.heroes = this.searchSubject
       .asObservable()           // cast as Observable
       .debounceTime(300)        // wait for 300ms pause in events
@@ -50,7 +52,7 @@ export class HeroSearchComponent implements OnInit {
   }
   // #enddocregion search
 
-  gotoDetail(hero: Hero) {
+  gotoDetail(hero: Hero): void {
     let link = ['/detail', hero.id];
     this.router.navigate(link);
   }
diff --git a/public/docs/_examples/toh-6/ts/app/hero-search.service.ts b/public/docs/_examples/toh-6/ts/app/hero-search.service.ts
@@ -1,6 +1,7 @@
 // #docregion
 import { Injectable }     from '@angular/core';
 import { Http, Response } from '@angular/http';
+import { Observable } from 'rxjs';
 
 import { Hero }           from './hero';
 
@@ -10,7 +11,7 @@ export class HeroSearchService {
   constructor(private http: Http) {}
 
   // #docregion observable-search
-  search(term: string) {
+  search(term: string): Observable<Hero[]> {
     return this.http
                .get(`app/heroes/?name=${term}+`)
                .map((r: Response) => r.json().data as Hero[]);
diff --git a/public/docs/_examples/toh-6/ts/app/hero.service.ts b/public/docs/_examples/toh-6/ts/app/hero.service.ts
@@ -1,7 +1,7 @@
 // #docplaster
 // #docregion
 import { Injectable }    from '@angular/core';
-import { Headers, Http } from '@angular/http';
+import { Headers, Http, Response } from '@angular/http';
 
 // #docregion rxjs
 import 'rxjs/add/operator/toPromise';
@@ -17,7 +17,7 @@ export class HeroService {
 
   constructor(private http: Http) { }
 
-  getHeroes() {
+  getHeroes(): Promise<Hero[]> {
     return this.http.get(this.heroesUrl)
     // #docregion to-promise
                .toPromise()
@@ -31,7 +31,7 @@ export class HeroService {
   }
   // #enddocregion getHeroes
 
-  getHero(id: number) {
+  getHero(id: number): Promise<Hero> {
     return this.getHeroes()
                .then(heroes => heroes.find(hero => hero.id === id));
   }
@@ -46,7 +46,7 @@ export class HeroService {
   // #enddocregion save
 
   // #docregion delete
-  delete(hero: Hero) {
+  delete(hero: Hero): Promise<Response> {
     let headers = new Headers();
     headers.append('Content-Type', 'application/json');
 
@@ -75,7 +75,7 @@ export class HeroService {
 
   // #docregion put
   // Update existing Hero
-  private put(hero: Hero) {
+  private put(hero: Hero): Promise<Hero> {
     let headers = new Headers();
     headers.append('Content-Type', 'application/json');
 
@@ -90,7 +90,7 @@ export class HeroService {
   // #enddocregion put
 
   // #docregion handleError
-  private handleError(error: any) {
+  private handleError(error: any): Promise<any> {
     console.error('An error occurred', error);
     return Promise.reject(error.message || error);
   }
diff --git a/public/docs/_examples/toh-6/ts/app/heroes.component.ts b/public/docs/_examples/toh-6/ts/app/heroes.component.ts
diff --git a/public/docs/ts/latest/tutorial/toh-pt4.jade b/public/docs/ts/latest/tutorial/toh-pt4.jade

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,8 @@ export class AppComponent {`
`102`	`102`	`// #enddocregion selected-hero`
`103`	`103`
`104`	`104`	`// #docregion on-select`
`105`		`- onSelect(hero: Hero) { this.selectedHero = hero; }`
	`105`	`+ onSelect(hero: Hero): void {`
	`106`	`+ this.selectedHero = hero;`
	`107`	`+ }`
`106`	`108`	`// #enddocregion on-select`
`107`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,5 +95,7 @@ export class AppComponent {`
`95`	`95`	`heroes = HEROES;`
`96`	`96`	`selectedHero: Hero;`
`97`	`97`
`98`		`- onSelect(hero: Hero) { this.selectedHero = hero; }`
	`98`	`+ onSelect(hero: Hero): void {`
	`99`	`+ this.selectedHero = hero;`
	`100`	`+ }`
`99`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,14 +84,16 @@ export class AppComponent implements OnInit {`
`84`	`84`	`constructor(private heroService: HeroService) { }`
`85`	`85`
`86`	`86`	`// #docregion get-heroes`
`87`		`- getHeroes() {`
	`87`	`+ getHeroes(): void {`
`88`	`88`	`this.heroService.getHeroes().then(heroes => this.heroes = heroes);`
`89`	`89`	`}`
`90`	`90`	`// #enddocregion get-heroes`
`91`	`91`
`92`		`- ngOnInit() {`
	`92`	`+ ngOnInit(): void {`
`93`	`93`	`this.getHeroes();`
`94`	`94`	`}`
`95`	`95`
`96`		`- onSelect(hero: Hero) { this.selectedHero = hero; }`
	`96`	`+ onSelect(hero: Hero): void {`
	`97`	`+ this.selectedHero = hero;`
	`98`	`+ }`
`97`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,7 @@ import { HEROES } from './mock-heroes';`
`10`	`10`	`@Injectable()`
`11`	`11`	`export class HeroService {`
`12`	`12`	`// #enddocregion empty-class`
`13`		`- getHeroes() {`
`14`		`- // #enddocregion getHeroes-stub`
`15`		`- return HEROES;`
`16`		`- // #docregion getHeroes-stub`
	`13`	`+ getHeroes(): void {`
`17`	`14`	`}`
`18`	`15`	`// #docregion empty-class`
`19`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,10 @@ export class DashboardComponent implements OnInit {`
`17`	`17`
`18`	`18`	`constructor(private heroService: HeroService) { }`
`19`	`19`
`20`		`- ngOnInit() {`
	`20`	`+ ngOnInit(): void {`
`21`	`21`	`this.heroService.getHeroes()`
`22`	`22`	`.then(heroes => this.heroes = heroes.slice(1, 5));`
`23`	`23`	`}`
`24`	`24`
`25`		`- gotoDetail() { /* not implemented yet */}`
	`25`	`+ gotoDetail(): void { /* not implemented yet */}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,13 +29,13 @@ export class DashboardComponent implements OnInit {`
`29`	`29`	`}`
`30`	`30`	`// #enddocregion ctor`
`31`	`31`
`32`		`- ngOnInit() {`
	`32`	`+ ngOnInit(): void {`
`33`	`33`	`this.heroService.getHeroes()`
`34`	`34`	`.then(heroes => this.heroes = heroes.slice(1, 5));`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`// #docregion goto-detail`
`38`		`- gotoDetail(hero: Hero) {`
	`38`	`+ gotoDetail(hero: Hero): void {`
`39`	`39`	`let link = ['/detail', hero.id];`
`40`	`40`	`this.router.navigate(link);`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,12 @@ export class DashboardComponent implements OnInit {`
`22`	`22`	`private heroService: HeroService) {`
`23`	`23`	`}`
`24`	`24`
`25`		`- ngOnInit() {`
	`25`	`+ ngOnInit(): void {`
`26`	`26`	`this.heroService.getHeroes()`
`27`	`27`	`.then(heroes => this.heroes = heroes.slice(1, 5));`
`28`	`28`	`}`
`29`	`29`
`30`		`- gotoDetail(hero: Hero) {`
	`30`	`+ gotoDetail(hero: Hero): void {`
`31`	`31`	`let link = ['/detail', hero.id];`
`32`	`32`	`this.router.navigate(link);`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ export class HeroDetailComponent implements OnInit, OnDestroy {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`// #docregion ngOnInit`
`31`		`- ngOnInit() {`
	`31`	`+ ngOnInit(): void {`
`32`	`32`	`this.sub = this.route.params.subscribe(params => {`
`33`	`33`	`if (params['id'] !== undefined) {`
`34`	`34`	`let id = +params['id'];`
`@@ -43,12 +43,12 @@ export class HeroDetailComponent implements OnInit, OnDestroy {`
`43`	`43`	`}`
`44`	`44`	`// #enddocregion ngOnInit`
`45`	`45`
`46`		`- ngOnDestroy() {`
	`46`	`+ ngOnDestroy(): void {`
`47`	`47`	`this.sub.unsubscribe();`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`// #docregion save`
`51`		`- save() {`
	`51`	`+ save(): void {`
`52`	`52`	`this.heroService`
`53`	`53`	`.save(this.hero)`
`54`	`54`	`.then(hero => {`
`@@ -59,7 +59,7 @@ export class HeroDetailComponent implements OnInit, OnDestroy {`
`59`	`59`	`}`
`60`	`60`	`// #enddocregion save`
`61`	`61`	`// #docregion goBack`
`62`		`- goBack(savedHero: Hero = null) {`
	`62`	`+ goBack(savedHero: Hero = null): void {`
`63`	`63`	`this.close.emit(savedHero);`
`64`	`64`	`if (this.navigated) { window.history.back(); }`
`65`	`65`	`}`