Class ControlValueAccessorBase<TValue, TEventData>

The base class for control value accessors interface

Type Parameters

TValue = ValidControlValue
TEventData extends ControlValueAccessorBaseEvents<TValue> = ControlValueAccessorBaseEvents<TValue>

Hierarchy (view full)

BaseEmitter<BaseParams, TEventData>
- ControlValueAccessorBase
  - AbstractControl

Implements

ControlValueAccessor<TValue>

Constructors

constructor

new ControlValueAccessorBase<TValue, TEventData>(config): ControlValueAccessorBase<TValue, TEventData>
Type Parameters
- TValue = ValidControlValue
- TEventData extends ControlValueAccessorBaseEvents<TValue> = ControlValueAccessorBaseEvents<TValue>
Parameters
- config: ControlValueAccessorBaseConfig
Returns ControlValueAccessorBase<TValue, TEventData>
Overrides BaseEmitter<BaseParams, TEventData>.constructor
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:41

Properties

eventData

eventData: TEventData

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

error

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

Returns string
Implementation of ControlValueAccessor.error
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:48

logger

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

params

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

`Static`historyInterval

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

`Static`historyTime

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

`Static`maxGcFrequency

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

`Static`maxHistoryDepth

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

Methods

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Inherited from BaseEmitter.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 string | number | symbol = keyof TEventData
- TEventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from BaseEmitter.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 string | number | symbol = keyof TEventData
- TEventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Inherited from BaseEmitter.emitSerial
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:10

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Inherited from BaseEmitter.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 string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Inherited from BaseEmitter.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 BaseEmitter.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 string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from BaseEmitter.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 BaseEmitter.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
- _: TValue
Returns void
- 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
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:94

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from BaseEmitter.once
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:16

registerOnChange

registerOnChange(fn): void
Registers a function called when the control value changes.
Parameters
- fn: ((_value: TValue) => void)
  - - (_value): void
    - Parameters
      _value: TValue
      Returns void
Returns void
void
Implementation of ControlValueAccessor.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
Implementation of ControlValueAccessor.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
Implementation of ControlValueAccessor.registerOnTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:118

`Protected`setError

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

`Protected`setPreviousValue

setPreviousValue(value): void
Sets the "previous value" of the input element.
Parameters
- value: TValue
Returns void
void
- 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
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:185

setTouched

setTouched(isTouched): void
Sets the "touched" state of the input element.
Parameters
- isTouched: boolean
Returns void
Implementation of ControlValueAccessor.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: TValue
- options: SetOptions = DefaultSetOptions
Returns void
void
Implementation of ControlValueAccessor.setValue
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:142

`Static`gc

gc(force?): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from BaseEmitter.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:29
gc(className): void
Parameters
- className: string
Returns void
Inherited from BaseEmitter.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 BaseEmitter.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 BaseEmitter.instanceCounts
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:32

`Static`startHistory

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

`Static`stopHistory

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

Class ControlValueAccessorBase<TValue, TEventData>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ControlValueAccessorBase<TValue, TEventData>

Properties

eventData

onErrorChange

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

error

Returns string

logger

Returns undefined | Logger

params

Returns TParams

previousValue

Returns TValue

serializeSettings

Returns ControlSerializeSettings

touched

Returns boolean

value

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

Parameters

Returns Promise<void>

emitSerial

Type Parameters

Parameters

Returns Promise<void>

listenerCount

Parameters

Returns number

off

Type Parameters

Parameters

Returns void

offAny

Parameters

Returns void

on

Type Parameters

Parameters

Returns (() => void)

Returns void

onAny

Parameters

Returns (() => void)

`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

`Static`gc

`Static`instanceCount

`Static`instanceCounts

`Static`startHistory

`Static`stopHistory