Class ApiService

whatitdoes

Reponsible for returning data from an API.

consumers

HomeComponent, RecipeComponent, RecipeAdComponent

providerscope

--------------------------------------------------------

Features:

Currently uses Firebase
Consumers don't need to know which API is used to get the data.
Could easily switch to use another API in the future without changing any of the API consumers.

Hierarchy

ApiService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ApiService(fbCache: FirebaseCacheService): ApiService

- Defined in core/api/api.service.ts:40
Creates the ApiService

Parameters
- fbCache: FirebaseCacheService
  
  Firebase cache service used to connect to Firebase and cache for offline use
Returns ApiService

Properties

about

about: Observable<object>

Observable of about data.

Private fbCache

fbCache: FirebaseCacheService

Firebase cache service used to connect to Firebase and cache for offline use

filterOptions

filterOptions: FilterOptionsObservable

Observable of filter options. Used to set up the FilterComponent

latest

latest: RecipeObservable

Observable of the latest recipe published.

recipes

recipes: Observable<Recipe[]>

Observable of a list of recipes.

Methods

onInit

onInit(): void

- Defined in core/api/api.service.ts:53
Called when creating the service.
- Gets the required items from Firebase to use in the app
Returns void

slugToRecipe

slugToRecipe(slug: string): RecipeObservable

- Defined in core/api/api.service.ts:67
Parameters
- slug: string
  
  a unique string associated with a recipe
Returns RecipeObservable

the recipe associated with the slug

Generated using TypeDoc