Interface ElementsValueAccessorOptions

Options applied to createElementsValueAccessor.

interface ElementsValueAccessorOptions {
    checkboxFormat?:
        | "boolean"
        | "value"
        | "booleanArray"
        | "valueArray"
        | "auto";
    dateFormat?:
        | "object"
        | "value"
        | "timestamp"
        | "iso"
        | "utc"
        | "gmt";
    timeFormat?: "number" | "value";
}

Properties

checkboxFormat? dateFormat? timeFormat?

Properties

OptionalcheckboxFormat

checkboxFormat?:
    | "boolean"
    | "value"
    | "booleanArray"
    | "valueArray"
    | "auto"

The format of checkbox values.

"boolean"

A single checkbox is a boolean, multiple checkboxes are an array of booleans.

"booleanArray"

An array of booleans.

"value"

A single checkbox is a value attribute if checked, or null if unchecked, multiple checkboxes are an array of checked values.

"valueArray"

An array of value attributes.

"auto"

A single checkbox is a boolean, multiple checkboxes are an array of checked values.

Default

"auto"

OptionaldateFormat

dateFormat?:
    | "object"
    | "value"
    | "timestamp"
    | "iso"
    | "utc"
    | "gmt"

The date format read from input elements.

"object"

A valid Date instance, or null if empty.

"timestamp"

A timestamp number.

"value"

The value attribute, or null if empty.

"iso"

An ISO date string.

"utc"

A UTC date string.

"gmt"

A GMT date string.

Default

"value"

OptionaltimeFormat

timeFormat?: "number" | "value"

The time format read from input elements.

"number"

The number of milliseconds passed from the start of the day.

"value"

The value attribute, or null if empty.

Default

"value"

Settings

Member Visibility

On This Page

Properties