Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(toh): add return types #1983

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion public/docs/_examples/toh-2/ts/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
4 changes: 3 additions & 1 deletion public/docs/_examples/toh-3/ts/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,7 @@ export class AppComponent {
heroes = HEROES;
selectedHero: Hero;

onSelect(hero: Hero) { this.selectedHero = hero; }
onSelect(hero: Hero): void {
this.selectedHero = hero;
}
}
10 changes: 6 additions & 4 deletions public/docs/_examples/toh-4/ts/app/app.component.1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
}
8 changes: 5 additions & 3 deletions public/docs/_examples/toh-4/ts/app/app.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
17 changes: 11 additions & 6 deletions public/docs/_examples/toh-4/ts/app/hero.service.1.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// #docplaster
// #docregion
// #docregion empty-class
// #docregion empty-class, full
import { Injectable } from '@angular/core';

// #enddocregion empty-class
Expand All @@ -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
}
13 changes: 13 additions & 0 deletions public/docs/_examples/toh-4/ts/app/hero.service.2.ts
Original file line number Diff line number Diff line change
@@ -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;
}
}
4 changes: 2 additions & 2 deletions public/docs/_examples/toh-4/ts/app/hero.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
);
Expand Down
4 changes: 2 additions & 2 deletions public/docs/_examples/toh-5/ts/app/dashboard.component.2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 */}
}
4 changes: 2 additions & 2 deletions public/docs/_examples/toh-5/ts/app/dashboard.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
4 changes: 2 additions & 2 deletions public/docs/_examples/toh-5/ts/app/hero-detail.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class HeroDetailComponent implements OnInit {
// #enddocregion ctor

// #docregion ng-oninit
ngOnInit() {
ngOnInit(): void {
// #docregion get-id
this.route.params.forEach((params: Params) => {
let id = +params['id'];
Expand All @@ -47,7 +47,7 @@ export class HeroDetailComponent implements OnInit {
// #enddocregion ng-oninit

// #docregion go-back
goBack() {
goBack(): void {
window.history.back();
}
// #enddocregion go-back
Expand Down
6 changes: 3 additions & 3 deletions public/docs/_examples/toh-5/ts/app/hero.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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));
}
Expand Down
10 changes: 6 additions & 4 deletions public/docs/_examples/toh-5/ts/app/heroes.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions public/docs/_examples/toh-6/ts/app/dashboard.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
6 changes: 3 additions & 3 deletions public/docs/_examples/toh-6/ts/app/hero-detail.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'];
Expand All @@ -43,7 +43,7 @@ export class HeroDetailComponent implements OnInit {
// #enddocregion ngOnInit

// #docregion save
save() {
save(): void {
this.heroService
.save(this.hero)
.then(hero => {
Expand All @@ -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(); }
}
Expand Down
10 changes: 6 additions & 4 deletions public/docs/_examples/toh-6/ts/app/hero-search.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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);
}
}
}
3 changes: 2 additions & 1 deletion public/docs/_examples/toh-6/ts/app/hero-search.service.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// #docregion
import { Injectable } from '@angular/core';
import { Http, Response } from '@angular/http';
import { Observable } from 'rxjs';

import { Hero } from './hero';

Expand All @@ -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[]);
Expand Down
12 changes: 6 additions & 6 deletions public/docs/_examples/toh-6/ts/app/hero.service.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand All @@ -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()
Expand All @@ -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));
}
Expand All @@ -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');

Expand Down Expand Up @@ -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');

Expand All @@ -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);
}
Expand Down
Loading