docs(toh): add return types

Foxandxss · wardbell · commit e9a41bac4713 · 2016-08-17T22:41:06.000-07:00
closes #1983
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
@@ -89,5 +89,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
@@ -7,7 +7,7 @@ import { Component } from '@angular/core';
 
 import { Hero } from './hero';
 // #docregion hero-service-import
-import { HeroService } from './hero.service.1';
+import { HeroService } from './hero.service.2';
 // #enddocregion hero-service-import
 
 // Testable but never shown
@@ -41,7 +41,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
@@ -50,14 +50,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
@@ -82,14 +82,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
@@ -1,6 +1,6 @@
 // #docplaster
 // #docregion
-// #docregion empty-class
+// #docregion empty-class, full
 import { Injectable } from '@angular/core';
 
 // #enddocregion empty-class
@@ -9,11 +9,16 @@ import { HEROES } from './mock-heroes';
 // #docregion empty-class, getHeroes-stub
 @Injectable()
 export class HeroService {
-  // #enddocregion empty-class
-  getHeroes() {
-    // #enddocregion getHeroes-stub
+  // #enddocregion empty-class, getHeroes-stub, full
+  /*
+  // #docregion getHeroes-stub
+  getHeroes(): void {
+  }
+  // #enddocregion getHeroes-stub
+  */
+  // #docregion full
+  getHeroes(): Hero[] {
     return HEROES;
-    // #docregion getHeroes-stub
   }
-  // #docregion empty-class
+  // #docregion empty-class, getHeroes-stub
 }
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-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(hero: Hero) { /* not implemented yet */}
+  gotoDetail(hero: Hero): 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 gotoDetail
-  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
@@ -16,7 +16,7 @@ import { HeroService } from './hero.service';
 })
 // #docregion implement
 export class HeroDetailComponent implements OnInit {
-  // #enddocregion implement
+// #enddocregion implement
   hero: Hero;
 
   // #docregion ctor
@@ -27,7 +27,7 @@ export class HeroDetailComponent implements OnInit {
   // #enddocregion ctor
 
   // #docregion ngOnInit
-  ngOnInit() {
+  ngOnInit(): void {
     this.route.params.forEach((params: Params) => {
       let id = +params['id'];
       this.heroService.getHero(id)
@@ -37,7 +37,7 @@ export class HeroDetailComponent implements OnInit {
   // #enddocregion ngOnInit
 
   // #docregion goBack
-  goBack() {
+  goBack(): void {
     window.history.back();
   }
 // #enddocregion goBack
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 getHero
-  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 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
@@ -19,12 +19,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
@@ -27,7 +27,7 @@ export class HeroDetailComponent implements OnInit {
   }
 
   // #docregion ngOnInit
-  ngOnInit() {
+  ngOnInit(): void {
     this.route.params.forEach((params: Params) => {
       if (params['id'] !== undefined) {
         let id = +params['id'];
@@ -43,7 +43,7 @@ export class HeroDetailComponent implements OnInit {
   // #enddocregion ngOnInit
 
   // #docregion save
-  save() {
+  save(): void {
     this.heroService
         .save(this.hero)
         .then(hero => {
@@ -54,7 +54,7 @@ export class HeroDetailComponent implements OnInit {
   }
   // #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
@@ -28,11 +28,13 @@ export class HeroSearchComponent implements OnInit {
   // #docregion searchTerms
 
   // Push a search term into the observable stream.
-  search(term: string) { this.searchTerms.next(term); }
+  search(term: string): void {
+    this.searchTerms.next(term);
+  }
   // #enddocregion searchTerms
   // #docregion search
 
-  ngOnInit() {
+  ngOnInit(): void {
     this.heroes = this.searchTerms
       .debounceTime(300)        // wait for 300ms pause in events
       .distinctUntilChanged()   // ignore if next search term is same as previous
@@ -49,8 +51,8 @@ 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';
 
@@ -9,7 +10,7 @@ export class HeroSearchService {
 
   constructor(private http: Http) {}
 
-  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
`@@ -89,5 +89,7 @@ export class AppComponent {`
`89`	`89`	`heroes = HEROES;`
`90`	`90`	`selectedHero: Hero;`
`91`	`91`
`92`		`- onSelect(hero: Hero) { this.selectedHero = hero; }`
	`92`	`+ onSelect(hero: Hero): void {`
	`93`	`+ this.selectedHero = hero;`
	`94`	`+ }`
`93`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,14 +82,16 @@ export class AppComponent implements OnInit {`
`82`	`82`	`constructor(private heroService: HeroService) { }`
`83`	`83`
`84`	`84`	`// #docregion get-heroes`
`85`		`- getHeroes() {`
	`85`	`+ getHeroes(): void {`
`86`	`86`	`this.heroService.getHeroes().then(heroes => this.heroes = heroes);`
`87`	`87`	`}`
`88`	`88`	`// #enddocregion get-heroes`
`89`	`89`
`90`		`- ngOnInit() {`
	`90`	`+ ngOnInit(): void {`
`91`	`91`	`this.getHeroes();`
`92`	`92`	`}`
`93`	`93`
`94`		`- onSelect(hero: Hero) { this.selectedHero = hero; }`
	`94`	`+ onSelect(hero: Hero): void {`
	`95`	`+ this.selectedHero = hero;`
	`96`	`+ }`
`95`	`97`	`}`
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(hero: Hero) { /* not implemented yet */}`
	`25`	`+ gotoDetail(hero: Hero): 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 gotoDetail`
`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
`@@ -19,12 +19,12 @@ export class DashboardComponent implements OnInit {`
`19`	`19`	`private heroService: HeroService) {`
`20`	`20`	`}`
`21`	`21`
`22`		`- ngOnInit() {`
	`22`	`+ ngOnInit(): void {`
`23`	`23`	`this.heroService.getHeroes()`
`24`	`24`	`.then(heroes => this.heroes = heroes.slice(1, 5));`
`25`	`25`	`}`
`26`	`26`
`27`		`- gotoDetail(hero: Hero) {`
	`27`	`+ gotoDetail(hero: Hero): void {`
`28`	`28`	`let link = ['/detail', hero.id];`
`29`	`29`	`this.router.navigate(link);`
`30`	`30`	`}`