Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

schema configurable options documentation added to README.md #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ fastify.register(
validateExistance: true,
},
},
// We can also add schema configurable options
options: {
timestamps: true,
},
},
{
name: "accounts",
Expand Down Expand Up @@ -113,12 +117,16 @@ Any models declared should follow the following format:
{
name: "profiles", // Required, should match name of model in database
alias: "Profile", // Optional, an alias to inject the model as
schema: schemaDefinition // Required, should match schema of model in database,
schema: schemaDefinition, // Required, should match schema of model in database,
options: schemaOptions, // Optional, schema configurable options
class: classDefinition // Optional, should be an ES6 class wrapper for the model
}
```

The `schemaDefinition` variable should be created according to the [Mongoose Model Specification](https://mongoosejs.com/docs/schematypes.html).

The `schemaOptions` variable should be created according to the [Mongoose Model Options Specification](https://mongoosejs.com/docs/guide.html#options).

The `classDefinition` variable should be created according to the [Mongoose Class Specification](https://mongoosejs.com/docs/4.x/docs/advanced_schemas.html).

## Author
Expand Down