Class JSONArrayField

EntityFieldDefinition for a Postres column with a JS JSON array type.

Hierarchy

EntityFieldDefinition<any[]>
- JSONArrayField

Index

Constructors

Properties

association cache columnName

Methods

validateInputValue validateInputValueInternal

Constructors

constructor

new JSONArrayField(options): JSONArrayField
Parameters
- options: EntityFieldDefinitionOptions
  options for this field definition
Returns JSONArrayField
Inherited from EntityFieldDefinition<any[]>.constructor
- Defined in packages/entity/build/EntityFieldDefinition.d.ts:130

Properties

`Readonly`association

association: undefined | EntityAssociationDefinition<any, any, any, any, any, any>

`Readonly`cache

cache: boolean

`Readonly`columnName

columnName: string

Methods

validateInputValue

validateInputValue(value): boolean
Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:
- EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
- EntityMutator.setField - to ensure the value being set is a valid value
Parameters
- value: undefined | null | any[]
Returns boolean
Inherited from EntityFieldDefinition.validateInputValue
- Defined in packages/entity/build/EntityFieldDefinition.d.ts:136

`Protected`validateInputValueInternal

validateInputValueInternal(value): boolean
Parameters
- value: any[]
Returns boolean
Overrides EntityFieldDefinition.validateInputValueInternal
- Defined in packages/entity-database-adapter-knex/src/EntityFields.ts:7