Skip to content
This repository was archived by the owner on Mar 20, 2024. It is now read-only.

Commit e9a41ba

Browse files
Foxandxsswardbell
authored andcommitted
docs(toh): add return types
closes #1983
1 parent fccb32d commit e9a41ba

19 files changed

Lines changed: 86 additions & 55 deletions

public/docs/_examples/toh-2/ts/app/app.component.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ export class AppComponent {
102102
// #enddocregion selected-hero
103103

104104
// #docregion on-select
105-
onSelect(hero: Hero) { this.selectedHero = hero; }
105+
onSelect(hero: Hero): void {
106+
this.selectedHero = hero;
107+
}
106108
// #enddocregion on-select
107109
}

public/docs/_examples/toh-3/ts/app/app.component.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,5 +89,7 @@ export class AppComponent {
8989
heroes = HEROES;
9090
selectedHero: Hero;
9191

92-
onSelect(hero: Hero) { this.selectedHero = hero; }
92+
onSelect(hero: Hero): void {
93+
this.selectedHero = hero;
94+
}
9395
}

public/docs/_examples/toh-4/ts/app/app.component.1.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Component } from '@angular/core';
77

88
import { Hero } from './hero';
99
// #docregion hero-service-import
10-
import { HeroService } from './hero.service.1';
10+
import { HeroService } from './hero.service.2';
1111
// #enddocregion hero-service-import
1212

1313
// Testable but never shown
@@ -41,7 +41,7 @@ export class AppComponent implements OnInit {
4141
constructor(private heroService: HeroService) { }
4242
// #enddocregion ctor
4343
// #docregion getHeroes
44-
getHeroes() {
44+
getHeroes(): void {
4545
// #docregion get-heroes
4646
this.heroes = this.heroService.getHeroes();
4747
// #enddocregion get-heroes
@@ -50,14 +50,16 @@ export class AppComponent implements OnInit {
5050

5151
// #docregion ng-on-init
5252
// #docregion on-init
53-
ngOnInit() {
53+
ngOnInit(): void {
5454
// #enddocregion on-init
5555
this.getHeroes();
5656
// #docregion on-init
5757
}
5858
// #enddocregion on-init
5959
// #enddocregion ng-on-init
6060

61-
onSelect(hero: Hero) { this.selectedHero = hero; }
61+
onSelect(hero: Hero): void {
62+
this.selectedHero = hero;
63+
}
6264
// #docregion on-init
6365
}

public/docs/_examples/toh-4/ts/app/app.component.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,16 @@ export class AppComponent implements OnInit {
8282
constructor(private heroService: HeroService) { }
8383

8484
// #docregion get-heroes
85-
getHeroes() {
85+
getHeroes(): void {
8686
this.heroService.getHeroes().then(heroes => this.heroes = heroes);
8787
}
8888
// #enddocregion get-heroes
8989

90-
ngOnInit() {
90+
ngOnInit(): void {
9191
this.getHeroes();
9292
}
9393

94-
onSelect(hero: Hero) { this.selectedHero = hero; }
94+
onSelect(hero: Hero): void {
95+
this.selectedHero = hero;
96+
}
9597
}
Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// #docplaster
22
// #docregion
3-
// #docregion empty-class
3+
// #docregion empty-class, full
44
import { Injectable } from '@angular/core';
55

66
// #enddocregion empty-class
@@ -9,11 +9,16 @@ import { HEROES } from './mock-heroes';
99
// #docregion empty-class, getHeroes-stub
1010
@Injectable()
1111
export class HeroService {
12-
// #enddocregion empty-class
13-
getHeroes() {
14-
// #enddocregion getHeroes-stub
12+
// #enddocregion empty-class, getHeroes-stub, full
13+
/*
14+
// #docregion getHeroes-stub
15+
getHeroes(): void {
16+
}
17+
// #enddocregion getHeroes-stub
18+
*/
19+
// #docregion full
20+
getHeroes(): Hero[] {
1521
return HEROES;
16-
// #docregion getHeroes-stub
1722
}
18-
// #docregion empty-class
23+
// #docregion empty-class, getHeroes-stub
1924
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// #docregion
2+
import { Injectable } from '@angular/core';
3+
4+
import { Hero } from './hero';
5+
import { HEROES } from './mock-heroes';
6+
7+
@Injectable()
8+
export class HeroService {
9+
10+
getHeroes(): Hero[] {
11+
return HEROES;
12+
}
13+
}

public/docs/_examples/toh-4/ts/app/hero.service.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import { HEROES } from './mock-heroes';
99
@Injectable()
1010
export class HeroService {
1111
// #docregion get-heroes
12-
getHeroes() {
12+
getHeroes(): Promise<Hero[]> {
1313
return Promise.resolve(HEROES);
1414
}
1515
// #enddocregion get-heroes, just-get-heroes
1616
// #enddocregion
1717
// See the "Take it slow" appendix
1818
// #docregion get-heroes-slowly
19-
getHeroesSlowly() {
19+
getHeroesSlowly(): Promise<Hero[]> {
2020
return new Promise<Hero[]>(resolve =>
2121
setTimeout(() => resolve(HEROES), 2000) // 2 seconds
2222
);

public/docs/_examples/toh-5/ts/app/dashboard.component.2.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ export class DashboardComponent implements OnInit {
1717

1818
constructor(private heroService: HeroService) { }
1919

20-
ngOnInit() {
20+
ngOnInit(): void {
2121
this.heroService.getHeroes()
2222
.then(heroes => this.heroes = heroes.slice(1, 5));
2323
}
2424

25-
gotoDetail(hero: Hero) { /* not implemented yet */}
25+
gotoDetail(hero: Hero): void { /* not implemented yet */}
2626
}

public/docs/_examples/toh-5/ts/app/dashboard.component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ export class DashboardComponent implements OnInit {
2929
}
3030
// #enddocregion ctor
3131

32-
ngOnInit() {
32+
ngOnInit(): void {
3333
this.heroService.getHeroes()
3434
.then(heroes => this.heroes = heroes.slice(1, 5));
3535
}
3636

3737
// #docregion gotoDetail
38-
gotoDetail(hero: Hero) {
38+
gotoDetail(hero: Hero): void {
3939
let link = ['/detail', hero.id];
4040
this.router.navigate(link);
4141
}

public/docs/_examples/toh-5/ts/app/hero-detail.component.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import { HeroService } from './hero.service';
1616
})
1717
// #docregion implement
1818
export class HeroDetailComponent implements OnInit {
19-
// #enddocregion implement
19+
// #enddocregion implement
2020
hero: Hero;
2121

2222
// #docregion ctor
@@ -27,7 +27,7 @@ export class HeroDetailComponent implements OnInit {
2727
// #enddocregion ctor
2828

2929
// #docregion ngOnInit
30-
ngOnInit() {
30+
ngOnInit(): void {
3131
this.route.params.forEach((params: Params) => {
3232
let id = +params['id'];
3333
this.heroService.getHero(id)
@@ -37,7 +37,7 @@ export class HeroDetailComponent implements OnInit {
3737
// #enddocregion ngOnInit
3838

3939
// #docregion goBack
40-
goBack() {
40+
goBack(): void {
4141
window.history.back();
4242
}
4343
// #enddocregion goBack

0 commit comments

Comments
 (0)