freeCodeCamp/curriculum/challenges/english/05-apis-and-microservices/mongodb-and-mongoose/create-a-model.md

id, title, challengeType, forumTopicId

id	title	challengeType	forumTopicId
587d7fb6367417b2b2512c07	Create a Model	2	301535

Description

CRUD Part I - CREATE

First of all we need a Schema. Each schema maps to a MongoDB collection. It defines the shape of the documents within that collection. Schemas are building block for Models. They can be nested to create complex models, but in this case we'll keep things simple. A model allows you to create instances of your objects, called documents.

Repl.it is a real server, and in real servers the interactions with the database happen in handler functions. These functions are executed when some event happens (e.g. someone hits an endpoint on your API). We’ll follow the same approach in these exercises. The done() function is a callback that tells us that we can proceed after completing an asynchronous operation such as inserting, searching, updating, or deleting. It's following the Node convention, and should be called as done(null, data) on success, or done(err) on error.

Warning - When interacting with remote services, errors may occur!

/* Example */

const someFunc = function(done) {
  //... do something (risky) ...
  if (error) return done(error);
  done(null, result);
};

Instructions

Create a person schema called personSchema having this prototype:

- Person Prototype -
--------------------
name : string [required]
age :  number
favoriteFoods : array of strings (*)

Use the Mongoose basic schema types. If you want you can also add more fields, use simple validators like required or unique, and set default values. See the Mongoose docs.

Now, create a model called Person from the personSchema.

Tests

tests:
  - text: Creating an instance from a mongoose schema should succeed
    testString: |
      getUserInput => $.post(getUserInput('url') + '/_api/mongoose-model', {name: 'Mike', age: 28, favoriteFoods: ['pizza', 'cheese']}).then(data => {
        assert.equal(data.name, 'Mike', '"model.name" is not what expected');
        assert.equal(data.age, '28', '"model.age" is not what expected');
        assert.isArray(data.favoriteFoods, '"model.favoriteFoods" is not an Array');
        assert.include(data.favoriteFoods, 'pizza', '"model.favoriteFoods" does not include the expected items');
        assert.include(data.favoriteFoods, 'cheese', '"model.favoriteFoods" does not include the expected items');
        }, xhr => { throw new Error(xhr.responseText); })

Challenge Seed

Solution

/**
  Backend challenges don't need solutions, 
  because they would need to be tested against a full working project. 
  Please check our contributing guidelines to learn more.
*/