Class MaybeJSONArrayField<TRequireExplicitCache>

EntityFieldDefinition for a Postgres column that may be a JS JSON array type. Does not do any validation.

Type Parameters

TRequireExplicitCache extends boolean

Hierarchy

EntityFieldDefinition<any | any[], TRequireExplicitCache>
- MaybeJSONArrayField

Index

Constructors

Properties

_cacheRawSentinel association cache columnName

Methods

validateInputValue validateInputValueInternal

Constructors

constructor

new MaybeJSONArrayField<TRequireExplicitCache extends boolean>(
    options: TRequireExplicitCache extends true
        ? EntityFieldDefinitionOptionsExplicitCache
        : EntityFieldDefinitionOptions,
): MaybeJSONArrayField<TRequireExplicitCache>
Type Parameters
- TRequireExplicitCache extends boolean
Parameters
- options: TRequireExplicitCache extends true
  ? EntityFieldDefinitionOptionsExplicitCache
  : EntityFieldDefinitionOptions
  options for this field definition
Returns MaybeJSONArrayField<TRequireExplicitCache>
Inherited from EntityFieldDefinition<any | any[], TRequireExplicitCache>.constructor
- Defined in entity/build/src/EntityFieldDefinition.d.ts:140

Properties

`Protected` `Readonly`_cacheRawSentinel

_cacheRawSentinel: TRequireExplicitCache

`Readonly`association

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

`Readonly`cache

cache: boolean

`Readonly`columnName

columnName: string

Methods

validateInputValue

validateInputValue(value: any): 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: any
Returns boolean
Inherited from EntityFieldDefinition.validateInputValue
- Defined in entity/build/src/EntityFieldDefinition.d.ts:146

`Protected`validateInputValueInternal

validateInputValueInternal(_value: any): boolean
Parameters
- _value: any
Returns boolean
Overrides EntityFieldDefinition.validateInputValueInternal
- Defined in entity-database-adapter-knex/src/EntityFields.ts:22