Type Alias NativeVariableFunctions

type NativeVariableFunctions = {
    forceContent: (s: string, d: number) => Promise<void>;
    getContent: () => Promise<AlfaNumString>;
    getNxProperties: () => Promise<NxVariableProperties>;
    getRawContent: () => Promise<string>;
    setContent: (content: string, updateMRU: boolean) => Promise<boolean>;
    setNxProperties: (properties: NxVariableProperties) => Promise<void>;
}
Index

Properties

forceContent getContent getNxProperties getRawContent setContent setNxProperties

Properties

forceContent: (s: string, d: number) => Promise<void>

Sets the value of a dual variable overriding any input constraints.

Parameters:

  • s - String representation of a dual value. Set this parameter to "", if the string representation is to be Null.
  • d - Numeric representation of a dual value.

@deprecated: Use GenericVariable::SetProperties method instead

Stability: locked

getContent: () => Promise<AlfaNumString>

Returns the calculated value of a variable.

@deprecated: Use GenericVariable::GetProperties method instead

Stability: locked

getNxProperties: () => Promise<NxVariableProperties>

Gets the properties of a variable.

@deprecated: Use GetProperties method instead

Stability: locked

getRawContent: () => Promise<string>

Returns the raw value of a variable.

@deprecated: Use GenericVariable::GetProperties method instead

Stability: locked

setContent: (content: string, updateMRU: boolean) => Promise<boolean>

Sets a value to a variable.

Parameters:

  • content - Value of the variable.
  • updateMRU - If set to true, the value is added to the Most Recently Used (MRU) list.

@deprecated: Use GenericVariable::SetProperties method instead

Stability: locked

setNxProperties: (properties: NxVariableProperties) => Promise<void>

Sets some properties to a variable.

Parameters:

  • properties - Information about the properties of the variable

@deprecated: Use SetProperties method instead

Stability: locked

Settings

Member Visibility

On This Page

Properties