Class ArrayField<ElementType>

A subclass of foundry.data.fields.DataField which deals with array-typed data.

Template: ElementType

Type Parameters

ElementType = DataField

Hierarchy (View Summary)

DataField
- ArrayField

Constructors

constructor

new ArrayField<ElementType = DataField>(
    element: ElementType,
    options?: ArrayFieldOptions,
    context?: DataFieldContext,
): ArrayField<ElementType>
Type Parameters
- ElementType = DataField
Parameters
- element: ElementType
  The type of element contained in the Array
- Optionaloptions: ArrayFieldOptions = {}
  Options which configure the behavior of the field
- Optionalcontext: DataFieldContext = {}
  Additional context which describes the field
Returns ArrayField<ElementType>
Overrides DataField.constructor

Properties

element

element: ElementType

The data type of each element in this array

`Internal`name

name: string | undefined

The field name of this DataField instance. This is assigned by SchemaField#initialize.

options

options: DataFieldOptions

The initially provided options which configure the data field

`Internal`parent

parent: any

A reference to the parent schema to which this DataField belongs. This is assigned by SchemaField#initialize.

persisted

persisted: boolean = true

Is a value of this field written to source data? A Non-persisted value is initialized (with its initial value), and ActiveEffects can use the field for change application.

`Static`hierarchical

hierarchical: boolean = false

Whether this field defines part of a Document/Embedded Document hierarchy.

`Static`recursive

recursive: boolean = true

Accessors

fieldPath

get fieldPath(): string
A dot-separated string representation of the field path within the parent schema.

Returns string
Inherited from DataField.fieldPath

`Static`_defaults

get _defaults(): DataFieldOptions & {
    empty: boolean;
    exact: undefined;
    max: number;
    min: number;
    nullable: boolean;
    required: boolean;
}
Default parameters for this field type

Returns DataFieldOptions & {
    empty: boolean;
    exact: undefined;
    max: number;
    min: number;
    nullable: boolean;
    required: boolean;
}
Overrides DataField._defaults

`Static`hasFormSupport

get hasFormSupport(): boolean
Does this form field class have defined form support?

Returns boolean
Inherited from DataField.hasFormSupport

Methods

_applyChangeAdd

_applyChangeAdd(value: any, delta: any, model: any, change: any): any
Parameters
- value: any
- delta: any
- model: any
- change: any
Returns any
Overrides DataField._applyChangeAdd

_applyChangeSubtract

_applyChangeSubtract(
    value: unknown[],
    delta: unknown[],
    model: any,
    change: any,
): unknown[]
Parameters
- value: unknown[]
- delta: unknown[]
- model: any
- change: any
Returns unknown[]
Overrides DataField._applyChangeSubtract

_cast

_cast(value: any): any[]
Parameters
- value: any
Returns any[]
Overrides DataField._cast

_castChangeDelta

_castChangeDelta(raw: any, replacementData: any): any[]
Parameters
- raw: any
- replacementData: any
Returns any[]
Overrides DataField._castChangeDelta

_cleanType

_cleanType(value: any, options: any, _state: any): any
When cleaning an ArrayField we must force {partial: false} since arrays are always fully replaced. We take care to preserve the provided array reference, cleaning its elements rather than replacing the array.
Parameters
- value: any
- options: any
- _state: any
Returns any
Overrides DataField._cleanType

_getField

_getField(parts: any, __namedParameters?: {}): any
Parameters
- parts: any
- __namedParameters: {} = {}
Returns any
Overrides DataField._getField

_updateCommit

_updateCommit(
    source: any,
    key: any,
    value: any,
    _diff: any,
    _options: any,
): void
Commit array field changes by replacing array contents while preserving the array reference itself.
Parameters
- source: any
- key: any
- value: any
- _diff: any
- _options: any
Returns void
Overrides DataField._updateCommit

_updateDiff

_updateDiff(key: any, value: any, options: any, state: any): void
Parameters
- key: any
- value: any
- options: any
- state: any
Returns void
Overrides DataField._updateDiff

_validateModel

_validateModel(changes: any, options: any): void
Parameters
- changes: any
- options: any
Returns void
Overrides DataField._validateModel

_validateRecursive

_validateRecursive(value: any, options: any): void
Parameters
- value: any
- options: any
Returns void
Overrides DataField._validateRecursive

_validateType

_validateType(value: any, options: any): void
Parameters
- value: any
- options: any
Returns void
Overrides DataField._validateType

apply

apply(fn: any, value?: any[], options?: {}): any[]
Parameters
- fn: any
- value: any[] = []
- options: {} = {}
Returns any[]
Overrides DataField.apply

applyChange

applyChange<T>(
    value: T,
    model: DataModel,
    change: EffectChangeData,
    options?: { replacementData?: Record<string, unknown> },
): T
Apply an ActiveEffectChange to this field.
Type Parameters
- T
Parameters
- value: T
  The field's current value.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The change to apply.
- options: { replacementData?: Record<string, unknown> } = {}
  Additional options to configure the change application.
  - OptionalreplacementData?: Record<string, unknown>
    Data used to resolve "@" expressions.
Returns T
The updated value.

Inherited from DataField.applyChange

clean

clean(
    value: any,
    options?: Readonly<DataModelCleaningOptions>,
    _state?: data.types.DataModelUpdateState,
): any
Preprocess and clean source data to ensure that it conforms to the correct data type for this field and is ready to be used by data model construction or update operations. Data cleaning is synchronous and automatically applied as the first step of construction and update operations.
Parameters
- value: any
  An initial requested value
- Optionaloptions: Readonly<DataModelCleaningOptions> = {}
  Additional options for how the field is cleaned
- Optional_state: data.types.DataModelUpdateState = {}
  Internal state variables which are used during recursion
Returns any
The cleaned value

Inherited from DataField.clean

getInitialValue

getInitialValue(source: any): any
Parameters
- source: any
Returns any
Overrides DataField.getInitialValue

initialize

initialize(value: any, model: any, options?: {}): any
Parameters
- value: any
- model: any
- options: {} = {}
Returns any
Overrides DataField.initialize

toFormGroup

toFormGroup(
groupConfig?: FormGroupConfig,
inputConfig?: FormInputConfig,
): HTMLDivElement
Render this DataField as a standardized form-group element.
Parameters
- groupConfig: FormGroupConfig = {}
  Configuration options passed to the wrapping form-group
- inputConfig: FormInputConfig = {}
  Input element configuration options passed to DataField#toInput
Returns HTMLDivElement
The rendered form group element

Inherited from DataField.toFormGroup

toInput

toInput(config?: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Render this DataField as an HTML element.
Parameters
- config: FormInputConfig = {}
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from DataField.toInput

toObject

toObject(value: any): any
Parameters
- value: any
Returns any
Overrides DataField.toObject

validate

validate(
value: any,
options?: DataFieldValidationOptions,
): void | DataModelValidationFailure
Validate candidate input for this field, ensuring it meets the field requirements.

This public method validates recursively, testing both the immediate value of this field as well as the validity of any child values for fields with hierarchical data types.
Parameters
- value: any
  The candidate value to validate
- Optionaloptions: DataFieldValidationOptions = {}
  Options which affect validation behavior
Returns void | DataModelValidationFailure
A failure that occurred if validation is non-strict. The failure may have been resolved by fallback or dropping invalid elements.

Throws
A failure error type including details of the failure if validation is performed strictly.

Inherited from DataField.validate

validators

validators(
options?: Pick<DataFieldValidationOptions, "recursive" | "phase">,
): Generator<DataFieldValidator, void, unknown>
Iterate over validation functions applied to this field. Validation happens in a depth-first way, for example consider an outerSchema with an innerField:
Parameters
- options: Pick<DataFieldValidationOptions, "recursive" | "phase"> = {}
Returns Generator<DataFieldValidator, void, unknown>
Example: Validator Invocation Order
```
outerSchema
  _validateSpecial
  _validateType
  _validateRecursive
  outerSchema.options.validate
    innerField
      _validateSpecial
      _validateType
      innerField.options.validate
      _validateModel
  _validateModel
```
Yields
Inherited from DataField.validators

`Protected`_applyChangeCustom

_applyChangeCustom(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a custom change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeCustom

`Protected`_applyChangeDowngrade

_applyChangeDowngrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "downgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeDowngrade

`Protected`_applyChangeMultiply

_applyChangeMultiply(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply a "multiply" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeMultiply

`Protected`_applyChangeOverride

_applyChangeOverride(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "override" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeOverride

`Protected`_applyChangeUpgrade

_applyChangeUpgrade(
    value: any,
    delta: any,
    model: DataModel,
    change: EffectChangeData,
): any
Protected
Apply an "upgrade" change to this field.
Parameters
- value: any
  The field's current value.
- delta: any
  The change delta.
- model: DataModel
  The model instance.
- change: EffectChangeData
  The original change data.
Returns any
The updated value.

Inherited from DataField._applyChangeUpgrade

`Protected`_cleanElement

_cleanElement(
    value: object,
    options: DataModelCleaningOptions,
    _state: data.types.DataModelUpdateState,
): object
Protected
Clean data for an individual element in the ArrayField.
Parameters
- value: object
  Unclean data for the array entry
- options: DataModelCleaningOptions
  Options which control how data is cleaned
- _state: data.types.DataModelUpdateState
  State used during data cleaning
Returns object
Cleaned data for the array entry

`Protected`_migrate

_migrate(
    value: any,
    options?: Readonly<DataModelCleaningOptions>,
    _state?: data.types.DataModelUpdateState,
): any
Protected
Migrate this field's candidate source data. This workflow occurs as a component step of DataField#clean.
Parameters
- value: any
  Candidate source value for the field
- Optionaloptions: Readonly<DataModelCleaningOptions>
  Options for how the field is cleaned
- Optional_state: data.types.DataModelUpdateState
  Internal state variables transacted during cleaning recursion.
Returns any
A migrated value suitable for cleaning

Inherited from DataField._migrate

`Protected`_replaceDataRefs

_replaceDataRefs(
    raw: string,
    data: Record<string, unknown>,
    options?: { strict?: boolean },
): string
Protected
Recursively replace data references in a string change value.
Parameters
- raw: string
- data: Record<string, unknown>
  An object providing replacements
- Optionaloptions: { strict?: boolean } = {}
  Additional options to configure the data replacement
  - Optionalstrict?: boolean
    Throw an Error if data replacement fails
Returns string
The expression with data references resolved

Inherited from DataField._replaceDataRefs

`Protected`_toInput

_toInput(config: FormInputConfig): HTMLElement | HTMLCollection | HTMLElement[]
Protected
Render this DataField as an HTML element. Subclasses should implement this method rather than the public toInput method which wraps it.
Parameters
- config: FormInputConfig
  Form element configuration parameters
Returns HTMLElement | HTMLCollection | HTMLElement[]
A rendered HTMLElement for the field

Throws
An Error if this DataField subclass does not support input rendering

Inherited from DataField._toInput

`Protected`_validateSpecial

_validateSpecial(value: any): boolean | void
Protected
Special validation rules which supersede regular field validation. This validator screens for certain values which are otherwise incompatible with this field like null or undefined.
Parameters
- value: any
  The candidate value
Returns boolean | void
A boolean to indicate with certainty whether the value is valid

Throws
An error with a specific reason the value is invalid

Inherited from DataField._validateSpecial

`Static`_handleValidationFailure

_handleValidationFailure(
    field: any,
    value: any,
    index: any,
    parentFailure: any,
    fieldFailure: any,
    options: any,
): void
Internal
Parameters
- field: any
- value: any
- index: any
- parentFailure: any
- fieldFailure: any
- options: any
Returns void
See
SchemaField._handleValidationFailure

`Protected` `Static`_validateElementType

_validateElementType(element: any): ElementType
Protected
Validate the contained element type of the ArrayField
Parameters
- element: any
  The type of Array element
Returns ElementType
The validated element type

Throws
An error if the element is not a valid type

Class ArrayField<ElementType>

Template: ElementType

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArrayField<ElementType>

Properties

element

Internalname

options

Internalparent

persisted

Statichierarchical

Staticrecursive

Accessors

fieldPath

Returns string

Static_defaults

Returns DataFieldOptions & { empty: boolean; exact: undefined; max: number; min: number; nullable: boolean; required: boolean;}

StatichasFormSupport

Returns boolean

Methods

_applyChangeAdd

Parameters

Returns any

_applyChangeSubtract

Parameters

Returns unknown[]

_cast

Parameters

Returns any[]

_castChangeDelta

Parameters

Returns any[]

_cleanType

Parameters

Returns any

_getField

Parameters

Returns any

_updateCommit

Parameters

Returns void

_updateDiff

Parameters

Returns void

_validateModel

Parameters

Returns void

_validateRecursive

Parameters

Returns void

_validateType

Parameters

Returns void

apply

Parameters

Returns any[]

applyChange

Type Parameters

Parameters

OptionalreplacementData?: Record<string, unknown>

Returns T

clean

Parameters

Returns any

getInitialValue

Parameters

Returns any

initialize

Parameters

Returns any

`Internal`name

`Internal`parent

`Static`hierarchical

`Static`recursive

`Static`_defaults

Returns DataFieldOptions & {
empty: boolean;
exact: undefined;
max: number;
min: number;
nullable: boolean;
required: boolean;
}

`Static`hasFormSupport

`Optional`replacementData?: Record<string, unknown>

`Protected`_applyChangeCustom

`Protected`_applyChangeDowngrade

`Protected`_applyChangeMultiply

`Protected`_applyChangeOverride

`Protected`_applyChangeUpgrade

`Protected`_cleanElement

`Protected`_migrate

`Protected`_replaceDataRefs

`Optional`strict?: boolean

`Protected`_toInput

`Protected`_validateSpecial

`Static`_handleValidationFailure

`Protected` `Static`_validateElementType