Base Field

Table of contents

1. Example Usage
2. Allowed Attributes
   1. Default
   2. Required
   3. Custom Name

All fields are extend from base BaseField This field can be used to store any kind of data in Firestore. This work also like Dynamic Field

Example Usage

const {Model, BaseField} = require("fireo");

class User extends Model{
    name = new BaseField()
    age = new BaseField();
}


const u = User.init();
u.name = "Azeem";
u.age = 26;
await u.save();

Allowed Attributes

The following attributes supported by DateTime Field.

1. default
2. required
3. name

• Default

  Default value for field. This is base attribute that is available in all fields. Set default value for field if no value is provided

Example Usage

const {Model, BaseField} = require("fireo");

class User extends Model{
    name = Field.Text({default: "Azeem"});
}

const u = User.init();
await u.save();

console.log(u.name)  // Azeem

• Required

  Set true if value is required for the field. If no value is provided error raise. This is base attribute that is available in all fields

Example Usage

const {Model, BaseField} = require("fireo");

class User extends Model{
    name = Field.Text({required: true});
}

const u = User.init();
u.name = "Azeem";
await u.save();

• Custom Name

Set different name in Firestore instead of field name. By default firestore name is same as the field name but you can change the firestore name in Firestore using this attribute. This is base attribute that is available in all fields

Example Usage

const {Model, BaseField} = require("fireo");

class User extends Model{
    name = Field.Text({name: "custom_name"});
}

const u = User.init();
u.name = "Azeem";
const u.save();