Interface IValueHostAccessor

For classes that hold resources that need to be disposed if the class is disposed.

interface IValueHostAccessor {
    dispose(): void;
    input(valueHostName): IInputValueHost;
    property(valueHostName): IPropertyValueHost;
    static(valueHostName): IStaticValueHost;
    calc(valueHostName): ICalcValueHost;
    any(valueHostName): IValueHost;
    validators(valueHostName): IValidatorsValueHostBase;
}

Hierarchy (view full)

IDisposable
- IValueHostAccessor

Implemented by

ValueHostAccessor

Index

Methods

dispose input property static calc any validators

Methods

dispose

dispose(): void
If the user needs to abandon this instance, they should use this to clean up active resources (like timers) and to release memory that would stall the garbage collector from disposing this object. It should assign any object reference to undefined as a strong indicator that the object has been disposed.

Returns void
Inherited from IDisposable.dispose
- Defined in packages/jivs-engine/src/Interfaces/General_Purpose.ts:17

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
- Defined in packages/jivs-engine/src/Interfaces/ValueHostAccessor.ts:21

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
- Defined in packages/jivs-engine/src/Interfaces/ValueHostAccessor.ts:27

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
- Defined in packages/jivs-engine/src/Interfaces/ValueHostAccessor.ts:34

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
- Defined in packages/jivs-engine/src/Interfaces/ValueHostAccessor.ts:40

any

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

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
- Defined in packages/jivs-engine/src/Interfaces/ValueHostAccessor.ts:66

Generated using TypeDoc v0.25.12