Documentation
    Preparing search index...

    Class ArrayProperty

    A property type that validates and manages arrays of primitive values. Allows enforcement of minimum and maximum element counts, as well as primitive type restrictions.

    const tags = new ArrayProperty({
       name: 'tags',
       minLength: 1,
       maxLength: 5,
       allowNumbers: false // Only string tags allowed
    });

    tags.set(['typescript', 'quatrain']); // OK
    tags.set([123]); // Throws Error: Numbers are not allowed in value

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _allows _defaultValue _events _hasChanged _htmlType _id _mandatory _maxLength _minLength _name _parent _protected _value EVENT_ONCHANGE EVENT_ONDELETE TYPE

    Accessors

    allows hasChanged htmlType mandatory maxLength minLength name protected

    Methods

    _enable clone get set toJSON val

    Constructors

    Properties

    Protected_allows

    _allows: string[] = []

    Protected_defaultValue

    _defaultValue: any

    Protected_events

    _events: { [key: string]: Function } = {}

    Protected_hasChanged

    _hasChanged: boolean

    Protected_htmlType

    _htmlType: PropertyHTMLType = 'off'

    Protected_id

    _id: string

    Protected_mandatory

    _mandatory: boolean = false

    Protected_maxLength

    _maxLength: number = 0

    Protected_minLength

    _minLength: number = 0

    Protected_name

    _name: string

    Protected_parent

    _parent: DataObjectClass<any> | undefined

    Protected_protected

    _protected: boolean = false

    Protected_value

    _value: any[] | undefined = undefined
    EVENT_ONCHANGE: string = 'onChange'

    Event name triggered when the property value changes.

    EVENT_ONDELETE: string = 'onDelete'

    Event name triggered when the property is deleted.

    TYPE: string = 'array'

    The string literal type identifier for this property.

    Accessors

    • get allows(): string[]

      Returns string[]

    • get hasChanged(): boolean

      Returns boolean

    • set hasChanged(val: boolean): void

      Parameters

      • val: boolean

      Returns void

    • get htmlType(): PropertyHTMLType

      Returns PropertyHTMLType

    • set htmlType(type: PropertyHTMLType): void

      Parameters

      Returns void

    • get mandatory(): boolean

      Returns boolean

    • get maxLength(): number

      Returns number

    • set maxLength(max: number): void

      Parameters

      • max: number

      Returns void

    • get minLength(): number

      Returns number

    • set minLength(min: number): void

      Parameters

      • min: number

      Returns void

    • get name(): string

      Returns string

    • get protected(): boolean

      Returns boolean

    Methods

    Protected_enable

    • _enable(value: boolean | undefined): value is true | undefined

      Parameters

      • value: boolean | undefined

      Returns value is true | undefined

    • Creates a deep clone of the current property instance, preserving its prototype chain.

      Returns any

      A new independent instance of the property.

    • Retrieves the array, optionally applying a mapping/transformation function.

      Parameters

      • transform: Function | undefined = undefined

        A custom function to apply to the array before returning it.

      Returns any

      The raw or transformed array.

    • Assigns a new array value while enforcing length constraints and content type rules.

      Parameters

      • value: any[]

        The array to assign. Null values are cast to empty arrays [].

      • setChanged: boolean = true

        Whether to mark the property as modified.

      Returns ArrayProperty

      The property instance for chaining.

      If the value is not an array, violates length bounds, or contains forbidden types.

    • Serializes the array for JSON stringification.

      Returns any[] | undefined

      The raw internal array.

    • Retrieves the current value of the property, or its default value if currently undefined.

      Parameters

      • transform: any = undefined

        An optional transformation function applied to the value before returning it.

      Returns any

      The raw or transformed property value.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods