anylist 0.8.3 | Documentation

anylist

0.8.3

AnyList ▸
- Instance members
- #login
- #teardown
- #getLists
- #getListById
- #getListByName
- #getFavoriteItemsByListId
- #getMealPlanningCalendarEvents
- #getRecentItemsByListId
- #createItem
- #getRecipes
- #createRecipe
- #createRecipeCollection
AnyList#lists-update
List ▸
- Instance members
- #addItem
- #uncheckAll
- #removeItem
- #getItemById
- #getItemByName
Item ▸
- Instance members
- #save
Recipe ▸
- Instance members
- #save
- #delete
Ingredient
RecipeCollection ▸
- Instance members
- #save
- #delete
- #addRecipe
- #removeRecipe
MealPlanningCalendarEvent
MealPlanningCalendarEventLabel

Need help reading this?

AnyList

AnyList class. There should be one instance per account.

new AnyList(options: object)

Extends EventEmitter

Parameters

options (object) account options

Name	Description
options.email `string`	email
options.password `string`	password
options.credentialsFile `string` (default `path.join(os.homedir(),'.anylist_credentials')`)	file path for credentials storage file

Properties

lists (Array<List>)

recentItems (Object<string, Array<Item>>)

favoriteItems (Array<List>)

recipes (Array<Recipe>)

Instance Members

▸ login(connectWebSocket)

Log into the AnyList account provided in the constructor.

Parameters

connectWebSocket

(any
            = true)

▸ teardown()

Call when you're ready for your program to exit.

teardown()

▸ getLists(refreshCache)

Load all lists from account into memory.

getLists(refreshCache: any): Promise<Array<List>>

Parameters

refreshCache

(any
            = true)

Returns

Promise<Array<List>>: lists

▸ getListById(identifier)

Get List instance by ID.

getListById(identifier: string): List

Parameters

identifier (string) list ID

Returns

List: list

▸ getListByName(name)

Get List instance by name.

getListByName(name: string): List

Parameters

name (string) list name

Returns

List: list

▸ getFavoriteItemsByListId(identifier)

Get favorite items for a list.

getFavoriteItemsByListId(identifier: string): List

Parameters

identifier (string) list identifier

Returns

List: favorites items array

▸ getMealPlanningCalendarEvents(refreshCache)

Load all meal planning calendar events from account into memory.

getMealPlanningCalendarEvents(refreshCache: any): Promise<Array<MealPlanningCalendarEvent>>

Parameters

refreshCache

(any
            = true)

Returns

Promise<Array<MealPlanningCalendarEvent>>: events

▸ getRecentItemsByListId(listId)

Get the recently added items for a list

getRecentItemsByListId(listId: string): Array<Item>

Parameters

listId (string) list ID

Returns

Array<Item>: recently added items array

▸ createItem(item)

Factory function to create new Items.

createItem(item: object): Item

Parameters

item (object) new item options

Returns

Item: item

▸ getRecipes(refreshCache)

Load all recipes from account into memory.

getRecipes(refreshCache: any): Promise<Array<Recipe>>

Parameters

refreshCache

(any
            = true)

Returns

Promise<Array<Recipe>>: recipes

▸ createRecipe(recipe)

Factory function to create new Recipes.

createRecipe(recipe: object): Recipe

Parameters

recipe (object) new recipe options

Returns

Recipe: recipe

▸ createRecipeCollection(recipeCollection)

Factory function to create new Recipe Collections.

createRecipeCollection(recipeCollection: object): RecipeCollection

Parameters

recipeCollection (object) new recipe options

Returns

RecipeCollection: recipe collection

AnyList#lists-update

Lists update event (fired when any list is modified by an outside actor). The instance's .lists are updated before the event fires.

AnyList#lists-update

Type: Array<List>

List

List class.

new List(list: object, context: object)

Parameters

list (object) list

context (object) context

Properties

identifier (string)

parentId (string)

name (string)

items (Array<Item>)

Instance Members

▸ addItem(item, isFavorite)

Adds an item to this list. Will also save item to local copy of list. Must set isFavorite=true if editing "favorites" list

addItem(item: Item, isFavorite: boolean): Promise<Item>

Parameters

item (Item) to add

isFavorite

(boolean
            = false)

Returns

Promise<Item>: saved item

▸ uncheckAll()

Uncheck all items in a list

uncheckAll(): Promise

Returns

Promise:

▸ removeItem(item, isFavorite)

Remove an item from this list. Will also remove item from local copy of list. Must set isFavorite=true if editing "favorites" list

removeItem(item: Item, isFavorite: boolean): Promise

Parameters

item (Item) to remove

isFavorite

(boolean
            = false)

Returns

Promise:

▸ getItemById(identifier)

Get Item from List by identifier.

getItemById(identifier: string): Item

Parameters

identifier (string) item ID

Returns

Item: found Item

▸ getItemByName(name)

Get Item from List by name.

getItemByName(name: string): Item

Parameters

name (string) item name

Returns

Item: found Item

Item

Item class.

new Item(item: object, context: object)

Parameters

item (object) item

context (object) context

Properties

listId (string)

identifier (string)

name (string)

details (string)

quantity (string)

checked (string)

manualSortIndex (string)

userId (string)

categoryMatchId (string)

Instance Members

▸ save(isFavorite)

Save local changes to item to AnyList's API. Must set isFavorite=true if editing "favorites" list

save(isFavorite: boolean): Promise

Parameters

isFavorite

(boolean
            = false)

Returns

Promise:

Recipe

Recipe class.

new Recipe(recipe: object, context: object)

Parameters

recipe (object) recipe

context (object) context

Properties

identifier (string)

timestamp (string)

name (string)

note (string)

sourceName (string)

sourceUrl (string)

ingredients (Array<Ingredient>)

preparationSteps (Array<string>)

photoIds (Array<string>)

adCampaignId (string)

photoUrls (Array<string>)

scaleFactor (double)

rating (int)

creationTimestamp (string)

nutritionalInfo (string)

cookTime (int)

prepTime (int)

servings (string)

paprikaIdentifier (string)

Instance Members

▸ save()

Save local changes to recipe to AnyList's API.

save(): Promise

Returns

Promise:

▸ delete()

Delete local changes to recipe to AnyList's API.

delete(): Promise

Returns

Promise:

Ingredient

Ingredient class (in progress).

new Ingredient(ingredient: object, context: object)

Parameters

ingredient (object) ingredient

context (object) context

Properties

rawIngredient (string)

name (string)

quantity (string)

note (string)

RecipeCollection

RecipeCollection class.

new RecipeCollection(recipeCollection: object, context: object)

Parameters

recipeCollection (object) recipeCollection

context (object) context

Properties

identifier (string)

timestamp (string)

name (string)

recipeIds (Array<string>)

preparationSteps (Array<string>)

photoIds (Array<string>)

adCampaignId (string)

photoUrls (Array<string>)

scaleFactor (double)

rating (int)

creationTimestamp (string)

nutritionalInfo (string)

cookTime (int)

prepTime (int)

servings (string)

paprikaIdentifier (string)

Instance Members

▸ save()

Save local changes to recipe to AnyList's API.

save(): Promise

Returns

Promise:

▸ delete()

Delete a recipe collection from AnyList.

delete(): Promise

Returns

Promise:

▸ addRecipe(recipeId)

Adds an existing recipe to an existing recipe-collection on AnyList.

addRecipe(recipeId: any): Promise

Parameters

recipeId (any)

Returns

Promise:

▸ removeRecipe(recipeId)

Remove existing recipe from an existing recipe-collection on AnyList.

removeRecipe(recipeId: any): Promise

Parameters

recipeId (any)

Returns

Promise:

MealPlanningCalendarEvent

Meal Planning Calendar Event class.

new MealPlanningCalendarEvent(event: object, labels: Array<object>, context: object)

Parameters

event (object) event

labels (Array<object>) labels

context (object) context

Properties

identifier (string)

calendarId (string)

date (Date)

details (string?)

labelId (string?)

label (MealPlanningCalendarEventLabel?)

logicalTimestamp (number?)

orderAddedSortIndex (number?)

recipeId (string?)

recipe (Recipe?)

recipeScaleFactor (number?)

title (string?)

MealPlanningCalendarEventLabel

Meal Planning Calendar Event Label class.

new MealPlanningCalendarEventLabel(label: object)

Parameters

label (object) label

Properties

identifier (string)

calendarId (string)

hexColor (string)

logicalTimestamp (number)

name (string)

sortIndex (number)