Class FormGroup<TValue, TStorageValue>

Organize form controls in a group.

NOTE: This is a work in progress and only supports top level controls. Nested controls are not supported.

Type Parameters

TValue extends PayloadWithTimestamp = PayloadWithTimestamp
TStorageValue extends PayloadWithTimestamp = PayloadWithTimestamp

Hierarchy (view full)

AbstractControl
- FormGroup

Constructors

constructor

new FormGroup<TValue, TStorageValue>(fgParams?): FormGroup<TValue, TStorageValue>
Type Parameters
- TValue extends SchemaFields & PayloadFields & {
      timestamp?: number;
  } & {
      schema: string;
  } = SchemaFields & PayloadFields & {
      timestamp?: number;
  } & {
      schema: string;
  }
- TStorageValue extends SchemaFields & PayloadFields & {
      timestamp?: number;
  } & {
      schema: string;
  } = SchemaFields & PayloadFields & {
      timestamp?: number;
  } & {
      schema: string;
  }
Parameters
- OptionalfgParams: FormGroupParams<TStorageValue>
Returns FormGroup<TValue, TStorageValue>
Overrides AbstractControl.constructor
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:43

Properties

eventData

eventData: AbstractControlEvents<ValidControlValue>

onErrorChange

onErrorChange: ((error: string) => void) = ...

Registers a function called when the control error changes.

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Static` `Readonly`globalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

disabled

get disabled(): boolean
Returns boolean
Deprecated
- disabled functionality not implemented
Inherited from AbstractControl.disabled
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:51

enabled

get enabled(): boolean
A control is enabled as long as its status is not DISABLED.

Returns boolean
True if the control has any status other than 'DISABLED', false if the status is 'DISABLED'.
Inherited from AbstractControl.enabled
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:61

error

get error(): string
The error message for the control.

Returns string
Inherited from AbstractControl.error
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:48

errorSummary

get errorSummary(): ErrorSummary
Returns ErrorSummary
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:47

errors

get errors(): FormGroupErrors<TValue>
Returns FormGroupErrors<TValue>
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:62

invalid

get invalid(): boolean
A control is invalid when its status is INVALID.

Returns boolean
True if this control has failed one or more of its validation checks, false otherwise.
Inherited from AbstractControl.invalid
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:72

logger

get logger(): undefined | Logger
Returns undefined | Logger
Inherited from AbstractControl.logger
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:27

nonSensitiveStorage

get nonSensitiveStorage(): undefined | FormGroupStorage<TStorageValue>
Returns undefined | FormGroupStorage<TStorageValue>
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:71

params

get params(): TParams
Returns TParams
Inherited from AbstractControl.params
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:28

pending

get pending(): boolean
A control is pending when its status is PENDING.

Returns boolean
True if this control is in the process of conducting a validation check, false otherwise.
Inherited from AbstractControl.pending
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:82

previousValue

get previousValue(): TValue
The "previous value" of the input element.

Returns TValue
Inherited from AbstractControl.previousValue
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:55

rawValue

get rawValue(): TValue
The raw value of the control.

Returns TValue
Inherited from AbstractControl.rawValue
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:89

sensitiveStorage

get sensitiveStorage(): undefined | FormGroupStorage<TStorageValue>
Returns undefined | FormGroupStorage<TStorageValue>
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:75

serializeSettings

get serializeSettings(): ControlSerializeSettings
The serialize settings of the input element.

Returns ControlSerializeSettings
Inherited from AbstractControl.serializeSettings
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:62

status

get status(): undefined | FormControlStatus
The current status of the control.

Returns undefined | FormControlStatus
Inherited from AbstractControl.status
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:96

touched

get touched(): boolean
The "touched" state of the input element.

Returns boolean
Overrides AbstractControl.touched
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:79

valid

get valid(): boolean
A control is valid when its status is VALID.

Returns boolean
True if the control has passed all of its validation tests, false otherwise.
Overrides AbstractControl.valid
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:83

value

get value(): TValue
The current value of the input element.

Returns TValue
Inherited from AbstractControl.value
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:76

values

get values(): TValue
Returns TValue
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:87

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from AbstractControl.historyInterval
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:20
set historyInterval(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.historyInterval
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from AbstractControl.historyTime
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:22
set historyTime(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.historyTime
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from AbstractControl.maxGcFrequency
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:24
set maxGcFrequency(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.maxGcFrequency
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from AbstractControl.maxHistoryDepth
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:26

Methods

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | ("statusChanged" | keyof ControlValueAccessorBaseEvents<ValidControlValue>)[]
Returns void
Inherited from AbstractControl.clearListeners
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:8

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) = "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          status: FormControlStatus;
      }
      | {
          value: ValidControlValue;
      } = AbstractControlEvents<ValidControlValue>[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractControl.emit
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:9

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) = "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          status: FormControlStatus;
      }
      | {
          value: ValidControlValue;
      } = AbstractControlEvents<ValidControlValue>[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from AbstractControl.emitSerial
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:10

getControl

getControl(name): Record<KeyOfString<TValue>, AbstractControl<ValidControlValue>>[KeyOfString<TValue>]
Parameters
- name: string
Returns Record<KeyOfString<TValue>, AbstractControl<ValidControlValue>>[KeyOfString<TValue>]
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:96

getSerializedValue

getSerializedValue(name, sensitive?): Promise<undefined | string>
Parameters
- name: string
- sensitive: boolean = false
Returns Promise<undefined | string>
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:100

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | ("statusChanged" | keyof ControlValueAccessorBaseEvents<ValidControlValue>)[]
Returns number
Inherited from AbstractControl.listenerCount
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:11

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns void
Inherited from AbstractControl.off
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:12

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener
Returns void
Inherited from AbstractControl.offAny
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:13

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from AbstractControl.on
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:14

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener
Returns (() => void)
- - (): void
  - Returns void
Inherited from AbstractControl.onAny
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:15

onChange

onChange(_): void
The registered callback function called when a change or input event occurs on the input element.
Parameters
- _: ValidControlValue
Returns void
Inherited from AbstractControl.onChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:84

onTouched

onTouched(_isTouched): void
The registered callback function called when a blur event occurs on the input element.
Parameters
- _isTouched: boolean
Returns void
Inherited from AbstractControl.onTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:94

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventName: TEventName
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from AbstractControl.once
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:16

registerControl

registerControl(name, control): void
Parameters
- name: string
- control: AbstractControl<ValidControlValue>
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:124

registerOnChange

registerOnChange(fn): void
Registers a function called when the control value changes.
Parameters
- fn: ((_value: ValidControlValue) => void)
  - - (_value): void
    - Parameters
      _value: ValidControlValue
      Returns void
Returns void
void
Inherited from AbstractControl.registerOnChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:101

registerOnErrorChange

registerOnErrorChange(fn): void
Registers a function called when the control error changes.
Parameters
- fn: ((error: string) => void)
  - - (error): void
    - Parameters
      error: string
      Returns void
Returns void
Inherited from AbstractControl.registerOnErrorChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:109

registerOnTouched

registerOnTouched(fn): void
Registers a function called when the control is touched.
Parameters
- fn: ((isTouched: boolean) => void)
  - - (isTouched): void
    - Parameters
      isTouched: boolean
      Returns void
Returns void
void
Inherited from AbstractControl.registerOnTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:118

resetControls

resetControls(): void
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:130

resetValues

resetValues(): void
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:136

`Protected`setError

setError(error): void
Set the error message for the control.
Parameters
- error: string
Returns void
Inherited from AbstractControl.setError
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:161

setErrorAndValidity

setErrorAndValidity(error, status): void
Parameters
- error: string
- status: FormControlStatus
Returns void
Inherited from AbstractControl.setErrorAndValidity
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:110

`Protected`setPreviousValue

setPreviousValue(value): void
Sets the "previous value" of the input element.
Parameters
- value: ValidControlValue
Returns void
void
Inherited from AbstractControl.setPreviousValue
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:177

`Protected`setSerializeSettings

setSerializeSettings(settings): void
Sets the serialize settings of the input element.
Parameters
- settings: ControlSerializeSettings
Returns void
Inherited from AbstractControl.setSerializeSettings
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:185

setStatus

setStatus(status): void
Parameters
- status: FormControlStatus
Returns void
Inherited from AbstractControl.setStatus
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:115

setTouched

setTouched(isTouched): void
Sets the "touched" state of the input element.
Parameters
- isTouched: boolean
Returns void
Inherited from AbstractControl.setTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:126

setValue

setValue(value, options?): void
Sets the "value" property on the input element.
Parameters
- value: ValidControlValue
- options: SetOptions = DefaultSetOptions
Returns void
void
Inherited from AbstractControl.setValue
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:142

unregisterControl

unregisterControl(name): void
Parameters
- name: string
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:142

validate

validate(): boolean
Returns boolean
Inherited from AbstractControl.validate
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:124

validateFields

validateFields(requiredFields?): void
Parameters
- OptionalrequiredFields: string[]
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/FormGroup.ts:153

`Static`gc

gc(force?): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from AbstractControl.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:29
gc(className): void
Parameters
- className: string
Returns void
Inherited from AbstractControl.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:30

`Static`instanceCount

instanceCount(className): number
Parameters
- className: string
Returns number
Inherited from AbstractControl.instanceCount
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:31

`Static`instanceCounts

instanceCounts(): Record<string, number>
Returns Record<string, number>
Inherited from AbstractControl.instanceCounts
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:32

`Static`startHistory

startHistory(): void
Returns void
Inherited from AbstractControl.startHistory
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from AbstractControl.stopHistory
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:34

Class FormGroup<TValue, TStorageValue>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FormGroup<TValue, TStorageValue>

Properties

eventData

onErrorChange

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

disabled

Returns boolean

Deprecated

enabled

Returns boolean

error

Returns string

errorSummary

Returns ErrorSummary

errors

Returns FormGroupErrors<TValue>

invalid

Returns boolean

logger

Returns undefined | Logger

nonSensitiveStorage

Returns undefined | FormGroupStorage<TStorageValue>

params

Returns TParams

pending

Returns boolean

previousValue

Returns TValue

rawValue

Returns TValue

sensitiveStorage

Returns undefined | FormGroupStorage<TStorageValue>

serializeSettings

Returns ControlSerializeSettings

status

Returns undefined | FormControlStatus

touched

Returns boolean

valid

Returns boolean

value

Returns TValue

values

Returns TValue

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

clearListeners

Parameters

Returns void

emit

Type Parameters

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Protected`setError