Model - Atileon/OC-p8 GitHub Wiki

Overview

This module iterates with the Storage and executes CRUD principles

Below will follow the methods for CRUD operations

Model.create

Creates a new todo model

• @param {string} [title] The title of the task
• @param {function} [callback] The callback to fire after the model is created

Model.read

Finds and returns a model in storage. If no query is given it'll simply return everything. If you pass in a string or number it'll look that up as the ID of the model to find. Lastly, you can pass it an object to match against.

• @param {string|number|object} [query] A query to match models against
• @param {function} [callback] The callback to fire after the model is found

@example

model.read(1, func); // Will find the model with an ID of 1

model.read('1'); // Same as above

//Below will find a model with foo equalling bar and hello equalling world.

model.read({ foo: 'bar', hello: 'world' });

Model.update

Updates a model by giving it an ID, data to update, and a callback to fire when the update is complete.

• @param {number} [id] The id of the model to update
• @param {object} [data] The properties to update and their new value
• @param {function} [callback] The callback to fire when the update is complete.

Model.remove

Removes a model from storage

• @param {number} [id] The ID of the model to delete
• @param {function} [callback] The callback to fire when the removal is complete.

Model.removeAll

WARNING: Will remove ALL data from storage.

• @param {function} [callback] The callback to fire when the storage is wiped.

Previous < The App (How it Works) -------/-------/------- Next > View