Class StringArrayField

EntityFieldDefinition for a column with a JS string array type. Enforces that every member of the string array is a string.

Hierarchy (view full)

EntityFieldDefinition<string[]>
- StringArrayField

Index

Constructors

Properties

association cache columnName

Methods

validateInputValue validateInputValueInternal

Constructors

constructor

new StringArrayField(options): StringArrayField
Parameters
- options: EntityFieldDefinitionOptions
  options for this field definition
Returns StringArrayField
Inherited from EntityFieldDefinition.constructor
- Defined in packages/entity/src/EntityFieldDefinition.ts:169

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 | string[]
Returns boolean
Inherited from EntityFieldDefinition.validateInputValue
- Defined in packages/entity/src/EntityFieldDefinition.ts:180

`Protected`validateInputValueInternal

validateInputValueInternal(value): boolean
Parameters
- value: string[]
Returns boolean
Overrides EntityFieldDefinition.validateInputValueInternal
- Defined in packages/entity/src/EntityFields.ts:69