IRISObject

"intersystems-iris". IRISObject

Class for proxy objects created on behalf of IRIS objects. Objects of this class are automatically created when the IRIS instance returns the object reference of a created object on the server. When given an instance of this class one can call methods and view/alter properties of an IRIS object directly from Node.js, unless the instance is closed.

Properties
Name Type Description
closed boolean

(readonly) closed indicates whether the object is closed
oref string

(readonly) IRIS object reference (OREF) of the IRIS object this instance corresponds to.
connection module:"intersystems-iris".Connection

(readonly) the connection to the IRIS server the IRIS object is accessible at.

Methods

# close()

Closes the IRIS object proxy.

# get(propertyName) → {null|any}

Retrieves the value of a property of the IRISObject object.

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the value of the property or null if property contains empty string

Type
null | any

# getBigInt(propertyName) → {bigint|null}

Retrieves the value of a property of the IRISObject object as an integer number.

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as an integer number or null if property contains an empty string

Type
bigint | null

# getBoolean(propertyName) → {boolean|null}

Retrieves the value of a property of the IRISObject object as a boolean

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as a boolean or null if property contains an empty string

Type
boolean | null

# getBytes(propertyName) → {Buffer|null}

Retrieves the value of a property of the IRISObject object as a Buffer

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as a Buffer or null if property contains an empty string

Type
Buffer | null

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

Retrieves the value of a property of the IRISObject object as a Decimal

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as a Decimal or null if property contains an empty string

Type
external:"decimal.js".Decimal | null

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

Retrieves the value of a property of the IRISObject object as an IRISList.

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as an IRISList or null if property contains an empty string. If property is not in IRIS list format an error will be thrown.

Type
module:"intersystems-iris".IRISList | null

# getNumber(propertyName) → {number|null}

Retrieves the value of a property of the IRISObject object as a number

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as a number or null if property contains an empty string

Type
number | null

# getObject(propertyName) → {null|any}

Retrieves the value of a property of the IRISObject object.

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the value of the property or null if property contains empty string

Type
null | any

# getString(propertyName) → {string|null}

Retrieves the value of a property of the IRISObject object as a string

Parameters:
Name Type Description
propertyName string

name of a property
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the property value as a string or null if property contains an empty string

Type
string | null

# invoke(methodName, …argument) → {any}

Invokes a method of the IRISObject object that returns a value.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation (null if empty string returned from IRIS)

Type
any

# invokeBigInt(methodName, …argument) → {bigint|null}

Invokes a method of the IRISObject object and returns the returned value as an integer number.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as an integer number or null if empty string returned from IRIS

Type
bigint | null

# invokeBoolean(methodName, …argument) → {boolean|null}

Invokes a method of the IRISObject object and returns the returned value as a boolean.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as a boolean or null if empty string returned from IRIS

Type
boolean | null

# invokeBytes(methodName, …argument) → {Buffer|null}

Invokes a method of the IRISObject object and returns the returned value as a Buffer.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as a Buffer or null if empty string returned from IRIS

Type
Buffer | null

# invokeDecimal(methodName, …argument) → {external:"decimal.js".Decimal|null}

Invokes a method of the IRISObject object and returns the returned value as a Decimal.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as a Decimal or null if empty string returned from IRIS.

Type
external:"decimal.js".Decimal | null

# invokeIRISList(methodName, …argument) → {module:"intersystems-iris".IRISList}

Invokes a method of the IRISObject object and returns the returned value as an IRISList.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as an IRISList. If empty string returned from IRIS the list will be empty.

Type
module:"intersystems-iris".IRISList

# invokeNumber(methodName, …argument) → {number|null}

Invokes a method of the IRISObject object and returns the returned value as a number.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as a number or null if empty string returned from IRIS

Type
number | null

# invokeObject(methodName, …argument) → {any}

Invokes a method of the IRISObject object that returns a value.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation (null if empty string returned from IRIS)

Type
any

# invokeString(methodName, …argument) → {string|null}

Invokes a method of the IRISObject object and returns the returned value as a string.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

Returns:

the return value of the method invocation as a string or null if empty string returned from IRIS

Type
string | null

# invokeVoid(methodName, …argument)

Invokes a method of the IRISObject object that does not return a value.

Parameters:
Name Type Attributes Description
methodName string

name of a method.
argument any <repeatable>

zero or more arguments to be passed to the method.
Throws:

  • If wrong number of arguments (at least 1)

  • If IRISObject closed

  • If no connection or iris present for this object

# set(propertyName, propertyValue)

Sets the value of a property of the IRISObject object.

Parameters:
Name Type Description
propertyName string

name of a property
propertyValue any

new value of the property
Throws:

  • If wrong number of arguments (at least 2)

  • If IRISObject closed

  • If no connection or iris present for this object