Class ValueHostAccessor

Used by ValueHostResolver's vm property to make it easier for the user to get strongly typed ValueHosts, compared to ValueHostResolver.getValueHost().

It simplies this syntax, shown for getting a value from a InputValueHost:

let ivh = vm.getValueHost("valuehostname") as IInputValueHost;
if (ivh)
   x = ivh.getInputValue();

The improved syntax:

x = vm.vh.input("valuehostname").getInputValue();

A key difference is that getValueHost may return null. The ValueHostAccessor treats unknown valuehosts and those that don't typecast correctly as exceptions.

Implements

IValueHostAccessor

Index

Constructors

constructor

new ValueHostAccessor(resolver): ValueHostAccessor
Parameters
- resolver: IValueHostResolver
Returns ValueHostAccessor
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:40

Accessors

`Protected` valueHostResolver

get valueHostResolver(): IValueHostResolver
Returns IValueHostResolver
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:56

Methods

dispose

dispose(): void
Participates in releasing memory. While not required, the idea is to be a more friendly participant in the ecosystem. Note that once called, expect null reference errors to be thrown if any other functions try to use them.

Returns void
Implementation of IValueHostAccessor.dispose
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:51

`Protected` ensureValueHost

ensureValueHost(valueHostName): IValueHost
Gets the ValueHost for the valueHostName or throws exception if not found.
Parameters
- valueHostName: string
Returns IValueHost
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:68

`Protected` ensureCorrectValueHost

ensureCorrectValueHost<T>(valueHostName, fn, className): T
Utility to get the strongly typed ValueHost, or throw exceptions for not found or not the correct class.
Type Parameters
- T extends IValueHost
Parameters
- valueHostName: string
- fn: ((vh) => null | T)
  - - (vh): null | T
    - Parameters
      vh: IValueHost
      Returns null | T
- className: string
Returns T
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:84

input

input(valueHostName): IInputValueHost
Returns the associated InputValueHost or throws an error when the valueHostName is unknown or not an InputValueHost.
Parameters
- valueHostName: string
Returns IInputValueHost
Implementation of IValueHostAccessor.input
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:97

property

property(valueHostName): IPropertyValueHost
Returns the associated PropertyValueHost or throws an error when the valueHostName is unknown or not an PropertyValueHost.
Parameters
- valueHostName: string
Returns IPropertyValueHost
Implementation of IValueHostAccessor.property
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:106

static

static(valueHostName): IStaticValueHost
Returns the associated StaticValueHost or throws an error when the valueHostName is unknown or not an StaticValueHost.
Parameters
- valueHostName: string
Returns IStaticValueHost
Implementation of IValueHostAccessor.static
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:115

calc

calc(valueHostName): ICalcValueHost
Returns the associated CalcValueHost or throws an error when the valueHostName is unknown or not an CalcValueHost.
Parameters
- valueHostName: string
Returns ICalcValueHost
Implementation of IValueHostAccessor.calc
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:124

any

any(valueHostName): IValueHost
Returns the associated ValueHost or throws an error when the valueHostName is unknown.
Parameters
- valueHostName: string
Returns IValueHost
Implementation of IValueHostAccessor.any
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:133

validators

validators(valueHostName): IValidatorsValueHostBase
Returns the associated Validatable ValueHost that supports validators or throws an error when the valueHostName is unknown or does not implement IValidatorsValueHostBase. Includes InputValueHost and PropertyValueHost.
Parameters
- valueHostName: string
Returns IValidatorsValueHostBase
Implementation of IValueHostAccessor.validators
- Defined in packages/jivs-engine/src/ValueHosts/ValueHostAccessor.ts:158

Class ValueHostAccessor

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ValueHostAccessor

Accessors

Protected valueHostResolver

Returns IValueHostResolver

Methods

dispose

Returns void

Protected ensureValueHost

Parameters

Returns IValueHost

Protected ensureCorrectValueHost

Type Parameters

Parameters

Parameters

Returns null | T

Returns T

input

Parameters

Returns IInputValueHost

property

Parameters

Returns IPropertyValueHost

static

Parameters

Returns IStaticValueHost

calc

Parameters

Returns ICalcValueHost

any

Parameters

Returns IValueHost

validators

Parameters

Returns IValidatorsValueHostBase

Settings

Member Visibility

Theme

On This Page

`Protected` valueHostResolver

`Protected` ensureValueHost

`Protected` ensureCorrectValueHost