Field

Decorates fields that should be used as fields. for more info see: Field Types

FieldOptions can be set in two ways:

example:

// as an object
@Fields.string({ includeInApi:false })
title='';

example:

// as an arrow function that receives `remult` as a parameter
@Fields.string((options,remult) => options.includeInApi = true)
title='';

valueType

The value type for this field

caption

A human readable name for the field. Can be used to achieve a consistent caption for a field throughout the app

example:

<input placeholder={taskRepo.metadata.fields.title.caption}/>

allowNull

If it can store null in the database

required

If a value is required

includeInApi

Specifies whether this field should be included in the API. This can be configured based on access control levels.

example:

// Do not include in the API
@Fields.string({ includeInApi: false })
password = '';
// Include in the API for 'admin' only
@Fields.number({ includeInApi: 'admin' })
salary = 0;

see:

- [allowed](https://remult.dev/docs/allowed.html)
- [Access Control](https://remult.dev/docs/access-control)

allowApiUpdate

Determines whether this field can be updated via the API. This setting can also be controlled based on user roles or other access control checks.

example:

// Prevent API from updating this field
@Fields.string({ allowApiUpdate: false })
createdBy = remult.user?.id;

see:

- [allowed](https://remult.dev/docs/allowed.html)
- [Access Control](https://remult.dev/docs/access-control)

validate

An arrow function that'll be used to perform validations on it

example:

@Fields.string({
  validate: Validators.required
})
*

example:

@Fields.string<Task>({
   validate: task=>task.title.length>3 ||  "Too Short"
})

example:

@Fields.string<Task>({
   validate: task=>{
     if (task.title.length<3)
         throw "Too Short";
  }
})

example:

@Fields.string({
   validate: (_, fieldValidationEvent)=>{
     if (fieldValidationEvent.value.length < 3)
         fieldValidationEvent.error = "Too Short";
  }
})

saving

Will be fired before this field is saved to the server/database

Arguments:

• entity
• fieldRef
• e

serverExpression

An expression that will determine this fields value on the backend and be provided to the front end

Arguments:

• entity

dbName

The name of the column in the database that holds the data for this field. If no name is set, the key will be used instead.

example:

@Fields.string({ dbName: 'userName'})
userName=''

sqlExpression

Used or fields that are based on an sql expressions, instead of a physical table column

example:

@Fields.integer({
  sqlExpression:e=> 'length(title)'
})
titleLength = 0;
@Fields.string()
title='';

dbReadOnly

For fields that shouldn't be part of an update or insert statement

valueConverter

The value converter to be used when loading and saving this field

displayValue

an arrow function that translates the value to a display value

Arguments:

• entity
• value

defaultValue

an arrow function that determines the default value of the field, when the entity is created using the repo.create method

Arguments:

• entity

inputType

The html input type for this field

lazy

• lazy

target

The entity type to which this field belongs

key

The key to be used for this field