Interface JSONField

JSONField defines "json" type field for storing any serialized JSON value.

The respective zero record field value is the zero [types.JSONRaw].

Hierarchy

Implemented by

Methods

calculateMaxBodySize columnType getHidden getId getName getSystem prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

help hidden id maxSize name presentable required system

Methods

calculateMaxBodySize

  • CalculateMaxBodySize implements the [MaxBodySizeCalculator] interface.

    Returns number

columnType

  • ColumnType implements [Field.ColumnType] interface method.

    Parameters

    Returns string

getHidden

  • GetHidden implements [Field.GetHidden] interface method.

    Returns boolean

getId

  • GetId implements [Field.GetId] interface method.

    Returns string

getName

  • GetName implements [Field.GetName] interface method.

    Returns string

getSystem

  • GetSystem implements [Field.GetSystem] interface method.

    Returns boolean

prepareValue

  • PrepareValue implements [Field.PrepareValue] interface method.

    Parameters

    Returns any

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

  • Type implements [Field.Type] interface method.

    Returns string

validateSettings

  • ValidateSettings implements [Field.ValidateSettings] interface method.

    Parameters

    Returns void

validateValue

  • ValidateValue implements [Field.ValidateValue] interface method.

    Parameters

    Returns void

Properties

help

help: string

Help is an extra text explaining what the field is about. It is usually shown in Dashboard UI under the field input.

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

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

maxSize

maxSize: number

MaxSize specifies the maximum size of the allowed field value (in bytes and up to 2^53-1).

If zero, a default limit of 1MB is applied.

name

name: string

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

presentable

presentable: boolean

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

required

required: boolean

Required will require the field value to be non-empty JSON value (aka. not "null", "", "[]", "{}").

system

system: boolean

System prevents the renaming and removal of the field.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc