Remult

# Field

Decorates fields that should be used as fields. for more info see: Field Types (opens new window)

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='';

# 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

# includeInApi

If this field data is included in the api.

see allowed (opens new window)

# allowApiUpdate

If this field data can be updated in the api.

see allowed (opens new window)

# 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=>{
     if (task.title.length<3)
         throw "Too Short";
  }
})

example

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

# 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.

# 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

Determines if the referenced entity will be loaded immediately or on demand.

*seelazy* loading of related entities (opens new window)

# valueType

The value type for this field

# target

The entity type to which this field belongs

# key

The key to be used for this field

# saving

  • saving

← Remult →