Class FormGroup<TValue, TStorageValue>

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/dist/browser/index.d.ts:187

Properties

eventData

eventData: AbstractControlEvents<ValidControlValue>

onChange

onChange: ((_: ValidControlValue) => void)

onErrorChange

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

onTouched

onTouched: ((_isTouched: boolean) => void)

`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
Inherited from AbstractControl.disabled
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:90

enabled

get enabled(): boolean
Returns boolean
Inherited from AbstractControl.enabled
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:91

error

get error(): string
Returns string
Inherited from AbstractControl.error
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:58

errorSummary

get errorSummary(): ErrorSummary
Returns ErrorSummary
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:188

errors

get errors(): FormGroupErrors<TValue>
Returns FormGroupErrors<TValue>
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:189

invalid

get invalid(): boolean
Returns boolean
Inherited from AbstractControl.invalid
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:92

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/dist/browser/index.d.ts:190

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
Returns boolean
Inherited from AbstractControl.pending
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:93

previousValue

get previousValue(): TValue
Returns TValue
Inherited from AbstractControl.previousValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:59

rawValue

get rawValue(): TValue
Returns TValue
Inherited from AbstractControl.rawValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:94

sensitiveStorage

get sensitiveStorage(): undefined | FormGroupStorage<TStorageValue>
Returns undefined | FormGroupStorage<TStorageValue>
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:191

serializeSettings

get serializeSettings(): ControlSerializeSettings
Returns ControlSerializeSettings
Inherited from AbstractControl.serializeSettings
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:60

status

get status(): undefined | FormControlStatus
Returns undefined | FormControlStatus
Inherited from AbstractControl.status
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:95

touched

get touched(): boolean
Returns boolean
Overrides AbstractControl.touched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:192

valid

get valid(): boolean
Returns boolean
Overrides AbstractControl.valid
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:193

value

get value(): TValue
Returns TValue
Inherited from AbstractControl.value
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:62

values

get values(): TValue
Returns TValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:194

`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: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]
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 (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" = (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          value: ValidControlValue;
      }
      | {
          status: FormControlStatus;
      } = 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 (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" = (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          value: ValidControlValue;
      }
      | {
          status: FormControlStatus;
      } = 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/dist/browser/index.d.ts:195

getSerializedValue

getSerializedValue(name, sensitive?): Promise<undefined | string>
Parameters
- name: string
- Optionalsensitive: boolean
Returns Promise<undefined | string>
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:196

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]
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 (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
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 (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
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

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
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/dist/browser/index.d.ts:197

registerOnChange

registerOnChange(fn): void
Parameters
- fn: ((_value: ValidControlValue) => void)
  - - (_value): void
    - Parameters
      _value: ValidControlValue
      Returns void
Returns void
Inherited from AbstractControl.registerOnChange
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:66

registerOnErrorChange

registerOnErrorChange(fn): void
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/dist/browser/index.d.ts:67

registerOnTouched

registerOnTouched(fn): void
Parameters
- fn: ((isTouched: boolean) => void)
  - - (isTouched): void
    - Parameters
      isTouched: boolean
      Returns void
Returns void
Inherited from AbstractControl.registerOnTouched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:68

resetControls

resetControls(): void
Returns void
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:198

resetValues

resetValues(): void
Returns void
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:199

`Protected`setError

setError(error): void
Parameters
- error: string
Returns void
Inherited from AbstractControl.setError
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:71

setErrorAndValidity

setErrorAndValidity(error, status): void
Parameters
- error: string
- status: FormControlStatus
Returns void
Inherited from AbstractControl.setErrorAndValidity
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:97

`Protected`setPreviousValue

setPreviousValue(value): void
Parameters
- value: ValidControlValue
Returns void
Inherited from AbstractControl.setPreviousValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:72

`Protected`setSerializeSettings

setSerializeSettings(settings): void
Parameters
- settings: ControlSerializeSettings
Returns void
Inherited from AbstractControl.setSerializeSettings
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:73

setStatus

setStatus(status): void
Parameters
- status: FormControlStatus
Returns void
Inherited from AbstractControl.setStatus
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:98

setTouched

setTouched(isTouched): void
Parameters
- isTouched: boolean
Returns void
Inherited from AbstractControl.setTouched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:69

setValue

setValue(value, options?): void
Parameters
- value: ValidControlValue
- Optionaloptions: SetOptions
Returns void
Inherited from AbstractControl.setValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:70

unregisterControl

unregisterControl(name): void
Parameters
- name: string
Returns void
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:200

validate

validate(): boolean
Returns boolean
Inherited from AbstractControl.validate
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:99

validateFields

validateFields(requiredFields?): void
Parameters
- OptionalrequiredFields: string[]
Returns void
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:201

`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

onChange

onErrorChange

onTouched

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

disabled

Returns boolean

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

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Protected`setError

`Protected`setPreviousValue

`Protected`setSerializeSettings