IRISReference

Constructor

# new IRISReference(value, typeopt)

Parameters:

Name	Type	Attributes	Default	Description
`value`	any			the value we want to pass by reference
`type`	module:"intersystems-iris".IRISReference.Type	<optional>	NONE	the type used as a type hint for unmarshaling the modified value of the argument. If NONE specified then the actual IRIS type of the data will be used

Throws:

Fails if insufficient number of arguments (at least 1)
Fails if type is not valid type.

Methods

# getBigInt() → {bigint}

Gets the value of this IRISReference object as an integer number

Returns:

the value the reference object holds as an integer number

Type: bigint

# getBoolean() → {boolean}

Gets the value of this IRISReference object as a boolean

Returns:

the value the reference object holds as a boolean

Type: boolean

# getBytes() → {Buffer}

Gets the value of this IRISReference object as a Buffer

Returns:

the value the reference object holds as a Buffer

Type: Buffer

# getDecimal() → {external:"decimal.js".Decimal}

Gets the value of this IRISReference object as a Decimal

Returns:

the value the reference object holds as a Decimal

Type: external:"decimal.js".Decimal

# getIRISList() → {module:"intersystems-iris".IRISList}

Gets the value of this IRISReference object as an IRISList

Returns:

the value the reference object holds as IRISList

Type: module:"intersystems-iris".IRISList

# getNumber() → {number}

Gets the value of this IRISReference object as number

Returns:

the value the reference object holds as number

Type: number

# getObject() → {any}

Gets the value of this IRISReference object

Returns:

the value the reference object holds

Type: any

# getString() → {string}

Gets the value of this IRISReference object as a string

Returns:

the value the reference object holds as string

Type: string

# getType() → {module:"intersystems-iris".IRISReference.Type}

Gets the (suggested) type of this IRISReference object

Returns:

the type of the referenced object

Type: module:"intersystems-iris".IRISReference.Type

# getValue() → {any}

Gets the value of this IRISReference object

Returns:

the value the reference object holds

Type: any

# setType(type)

Changes the (suggested) type of the value the IRISReference object referes to

Parameters:

Name	Type	Description
`type`	module:"intersystems-iris".IRISReference.Type	the (suggested) type of the value we want to pass by reference

# setValue(value)

Sets the value the IRISReference object referes to

Parameters:

Name	Type	Description
`value`	any	the value we want to pass by reference

Type Definitions

# Type

Properties

Name	Type	Description
`NONE`	number	0
`BOOLEAN`	number	1
`BYTES`	number	2
`DECIMAL`	number	3
`BIGINT`	number	4
`NUMBER`	number	5
`IRISLIST`	number	6
`STRING`	number	7