AutodateField defines an "autodate" type field, aka. field which datetime value could be auto set on record create/update.

This field is usually used for defining timestamp fields like "created" and "updated".

Requires either both or at least one of the OnCreate or OnUpdate options to be set.

Hierarchy

Implements

Constructors

Methods

  • Intercept implements the [RecordInterceptor] interface.

    Parameters

    Returns void

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

Properties

hidden: boolean

Hidden hides the field from the API response.

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

name: string

Name (required) is the unique name of the field.

onCreate: boolean

OnCreate auto sets the current datetime as field value on record create.

onUpdate: boolean

OnUpdate auto sets the current datetime as field value on record update.

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

system: boolean

System prevents the renaming and removal of the field.

Generated using TypeDoc