remotestorage-module-flashcards

flashcards

A remoteStorage data module for flashcards.

Maintained by Nick Jennings [e-mail]

All flashcards are stored as timestamps.

• flashcards
  • store(frontText, backText) ⇒ Promise ⏏
  • remove(group, id) ⇒ Promise ⏏
  • get(id) ⇒ object ⏏
  • listGroups() ⇒ Promise ⏏
  • getAllByGroup(group) ⇒ Promise ⏏

store(frontText, backText) ⇒ Promise ⏏

Stores a flashcard

Kind: Exported function
Returns: Promise - A promise, which will be fulfilled with the updated flashcard object
Access: public

Param	Type	Description
frontText	string	Filename
backText	string	Filename

Example

remoteStorage.flashcards.store(flashcard)
  .then((flashcard) => { console.log(`the updated flashcard object is: ${flashcard}`)

remove(group, id) ⇒ Promise ⏏

Remove a flashcard

Kind: Exported function
Access: public

Param	Type	Description
group	string	The group name of the flashcard
id	string	The ID of the flashcard

get(id) ⇒ object ⏏

Get a flashcard.

Kind: Exported function
Returns: object - The flashcard object
Access: public

Param	Type	Description
id	string	the ID of the flashcard

listGroups() ⇒ Promise ⏏

List all flashcard groups

Kind: Exported function
Returns: Promise - Resolves with an array containing the flashcard group names
Access: public

getAllByGroup(group) ⇒ Promise ⏏

List all flashcards in a group

Kind: Exported function
Returns: Promise - Resolves with an array containing all the flashcard objects of that group
Access: public

Param	Type	Description
group	string	the name of the group