JSDoc: Global

Members

(constant) MAIN_API_URL

How to use: After DATA is initialized automatically: inside init() function, under "await fetchRecipes();": call getRecipeCardInfo() to get recipe id,diets,image and title of all fetched recipes NOTE 1:I store fetched data in DATA. To access DATA, access inside init() function or there will be nothing. NOTE 2:DATA[0]['results'][0] returns first recipe; DATA[0]['results'][1] returns second one; aka DATA[0]['results'] = recipeData in lab 6 NOTE 3:main link https://spoonacular.com/food-api/docs#Search-Recipes-Complex

Source:

api_script.js, line 15

Methods

addMoreIngredients(ig)

This hepler function adds ingredients to the edit recipe.

Parameters:

Name	Type	Description
`ig`	string	ingredient

Source:

main.js, line 899

addMoreInstructions(ins)

This hepler function adds instructions to the edit recipe

Parameters:

Name	Type	Description
`ins`	string	instruction

Source:

main.js, line 915

addNewCookBook()

This function ask user to enter new cookbook's name, store it to local storage and call appendNewCookBook()

Source:

main.js, line 825

addRemoveCookBook(button)

This function removes a cookbook from cookbook List

Parameters:

Name	Type	Description
`button`	HTMLElement	the button that adds the cookbook

Source:

main.js, line 1151

addRemoveRecipe(button)

This function removes recipe from a cookbook

Parameters:

Name	Type	Description
`button`	HTMLElement	the button that removes the recipe

Source:

main.js, line 1134

appendNewCookBook(newCookBook)

This function adds new cookbook to the save-cookbook menu

Parameters:

Name	Type	Description
`newCookBook`	string

Source:

main.js, line 802

bindAll()

Calls all binding functions above and is called in the init function

Source:

script.js, line 65

bindAppNameClick()

Returns to home when app name is clicked

Source:

script.js, line 740

bindCategoryCards(categoryCard, categoryName)

Binds the click event to the category card to initiate the search

Parameters:

Name	Type	Description
`categoryCard`	Element	the category card to bind to
`categoryName`	String	the name of the category searched

Source:

script.js, line 669

bindCookbookPage()

Goes to cookbook page when cookbook is clicked

Source:

script.js, line 757

bindCuisineFilters()

This function adds an event listener waiting for the user to click on the cuisine filters button and change the direction of the arrow icon which will then call toggleCuisineFilters() method to either reveal or hide the cuisine filters drop down menu

Source:

script.js, line 827

bindDietFilters()

This function adds an event listener waiting for the user to click on the diet filters button which will then call toggleDietFilters() method to either reveal or hide the diet filters drop down menu and change the direction of the arrow icon

Source:

script.js, line 813

bindHomePage()

Goes to home page when home is clicked

Source:

script.js, line 796

bindMealFilters()

This function adds an event listener waiting for the user to click on the meal type filters button which will then call toggleMealTypeFilters() method to either reveal or hide the meal type filters drop down menu and change the direction of the arrow icon

Source:

script.js, line 850

bindNewCookBook(li)

This functions bind a cookbook / add an event upon click, so that when users click on a cookbook, it saves the current recipe to the cookbook that user chose

Parameters:

Name	Type	Description
`li`	HTMLObjectElement	the cookbook to save to

Source:

main.js, line 749

bindPopState()

Binds a pop state to a routing page

Source:

script.js, line 46

bindSettingsPage()

Goes to setting page when settings is clicked

Source:

script.js, line 780

bindTimeFilters()

This function adds an event listener waiting for the user to click on the time filters button which will then call toggleTimeFilters() method to either reveal or hide the time filters drop down menu and change the direction of the arrow icon

Source:

script.js, line 838

checkBookMark(data)

This function check if the recurrent recipe has been whether saved or not. If the data has been saved, display bookmark and edit recipe, and load data from local storage.

Parameters:

Name	Type	Description
`data`	Object

Source:

main.js, line 666

clearAllFilters()

This function removes all the filter cards and clears all checkboxes

Source:

main.js, line 231

clearCheckBoxes()

Clears check boxes on a recipe page and list

Source:

main.js, line 194

clearFilterCheckBoxes()

Clears check boxes in the filter drop down menus

Source:

main.js, line 204

createCategoryCards()

Creates 6 category cards from the categories and images arrays above using random values so every time the user refreshes, there will be a new set of categories

Source:

script.js, line 617

createFilters()

Function to create filter-card elements based off of the selected filters in the filters array.

Source:

script.js, line 337

emailRecipe()

Open the share recipe modal

Source:

main.js, line 1007

(async) fetchRecipes(queries, callbackFn) → {Promise}

Fetch the recipes for the search page

Parameters:

Name	Type	Description
`queries`	String	string that contains all query parameters for API call
`callbackFn`	function	assigns the value from the fetch to the global variable

Source:

api_script.js, line 26

Returns:

a Promise for whether or not a recipe has been loaded successfully

Type: Promise

getIngredients(data) → {Array}

Extract the ingredients from data

Parameters:

Name	Type	Description
`data`	Object	JSON

Source:

RecipePage.js, line 427

Returns:

return a list of ingredients

Type: Array

getInstructions(data) → {Array}

Extract the instructions from data

Parameters:

Name	Type	Description
`data`	Object	JSON

Source:

RecipePage.js, line 444

Returns:

return a list of instructions

Type: Array

getRecipeCardInfo(data) → {Array}

Extract needed info of all recipes fetched as an array

Parameters:

Name	Type	Description
`data`	Array	an array of data for a recipe card

Source:

api_script.js, line 55

Returns:

an array of extracted data for a recipe card

Type: Array

getRecipeCardInfo(data) → {Object}

Extract needed info of all recipes fetched as an array

Parameters:

Name	Type	Description
`data`	Object	the data of the recipe card

Source:

helper.js, line 8

Returns:

{{diets1,id1,image1,title1},{diets2,id2,image2,title2},...}

Type: Object

hideApplyBtn()

This function hides the apply filters button

Source:

main.js, line 486

hideCategoryCards()

Hide category cards

Source:

main.js, line 397

hideClearFiltersBtn()

This function should only be called when no filters are selected, showing, or is on another page like the settings home, or cookbook page. Thus the clear filters button should only show when a filter is selected but disappear all other times

Source:

main.js, line 508

hideCookbooks()

Hide cookbooks page

Source:

main.js, line 324

hideEditRecipe()

Hide edit recipe button

Source:

main.js, line 791

hideFilterBtns()

This function hides the filter buttons

Source:

main.js, line 447

hideFilters()

This function hides the filter drop down menus

Source:

main.js, line 413

hideHome()

Hide the home page

Source:

main.js, line 274

hideRecipeCards()

Hide recipe cards

Source:

main.js, line 377

hideRecipePage()

Hide recipe page

Source:

main.js, line 350

hideSearchBar()

Hide search bar

Source:

main.js, line 297

hideSelectedFilters()

This function hides the selected filters container

Source:

main.js, line 559

hideSettings()

Hide the settings

Source:

main.js, line 243

hideTapMode()

Hide tap mode button

Source:

main.js, line 619

(async) init()

When page is initialized, create a home page to show

Source:

script.js, line 81

load()

This function loads all ingredients and instructions to the Edit Recipe popup

Source:

main.js, line 845

printRecipe()

Print a recipe from the recipe page

Source:

main.js, line 1000

removeIngredient()

this function removes the last ingredient in the ingredients list

Source:

main.js, line 929

removeInstruction()

This function removes the last intructions in the instructions list

Source:

main.js, line 937

removeRecipe(Id)

This function removes recipe from localstorage

Parameters:

Name	Type	Description
`Id`	string	of recipe

Source:

main.js, line 1176

resetFilters()

This function removes all the filter cards in order to display new ones each time a user selects a new filter

Source:

main.js, line 220

search() → {Boolean}

The search function, calls API functoin to fetch all recipes Generates recipe cards by passing in values into RecipeData

Source:

script.js, line 521

Returns:

Whether search was successful

Type: Boolean

(async) searchByCategory() → {Promise}

Function to search when a category card is clicked

Source:

script.js, line 697

Returns:

a Promise whether recipes have been fetched correctly

Type: Promise

searchByFilter()

Function to filter the search the by the filters that the user selects

Source:

script.js, line 352

showApplyBtn()

This function shows the apply filters button

Source:

main.js, line 474

showBookMarkEditReipce()

This helper function display bookmark-filled and display editRecipe

Source:

main.js, line 985

showCategoryCards()

Show category cards

Source:

main.js, line 387

showClearFiltersBtn()

This function just reveals the clear filters button which should only appear after a filter is selected in any category

Source:

main.js, line 497

showCookBookMenu()

This functions displays all the cookbooks in local storage to the saved-cookbook menu when users click on bookmark. There is one cookbook by default - "favorites". If bookmark has been marked/filled. It removes the recipe from local Storage.

Source: