IDbOptions | SakuraApi

Defines the valid options for @Db.

Hierarchy

IDbOptions

Index

Properties

Optional field

field: string

The database field name that is mapped to and from this property by Model.toDb and Model.fromDb.

Example

   @Model({...})
   export class SomeModel {
       @Db({
         field: 'fn'
       })
       firstName: string = '';
   }

Explanation: firstName property of the @Model is mapped to the fn field of the database.

Optional model

model: any

An optional @Model decorated class. If provided, the property will be instantiated as a sub document with its default values or the values from the database. @Json will utilize this same model if one is not set on that attribute.

Optional private

private: boolean

Prevents this property from being marshaled to json by the built in toJson method that is attached to @Model decorated classes.

Example

   @Model({...})
   export class SomeModel {
       @Db({
         private: true
       })
       firstName: string = '';
   }

Explanation: the firstName property will be mapped to the firstName property of a database document, but it will not be included in the output of someModel.toJson().