Class Array

JsonArray is the representation of the array type inside JSON.

A JsonArray contains [structJson.Node] elements, which may contain fundamental types, other arrays or objects.

Since arrays can be arbitrarily big, copying them can be expensive; for this reason, they are reference counted. You can control the lifetime of a JsonArray using [methodJson.Array.ref] and [methodJson.Array.unref].

To append an element, use [methodJson.Array.add_element].

To extract an element at a given index, use [methodJson.Array.get_element].

To retrieve the entire array in list form, use [methodJson.Array.get_elements].

To retrieve the length of the array, use [methodJson.Array.get_length].

record

Hierarchy

Array

Constructors

constructor

new Array(): Json.Array

- Defined in Json-1.0.d.ts:2143
Creates a new array.

Returns Json.Array

Properties

Static name

name: string

Methods

addArrayElement

addArrayElement(value: Json.Array): void

- Defined in Json-1.0.d.ts:1929
Conveniently adds an array element into an array.

If value is NULL, a null element will be added instead.

See also: [methodJson.Array.add_element], [methodJson.Node.take_array]

Parameters
- value: Json.Array
  
  the array to add
Returns void

addBooleanElement

addBooleanElement(value: boolean): void

- Defined in Json-1.0.d.ts:1936
Conveniently adds the given boolean value into an array.

See also: [methodJson.Array.add_element], [methodJson.Node.set_boolean]

Parameters
- value: boolean
  
  the boolean value to add
Returns void

addDoubleElement

addDoubleElement(value: number): void

- Defined in Json-1.0.d.ts:1943
Conveniently adds the given floating point value into an array.

See also: [methodJson.Array.add_element], [methodJson.Node.set_double]

Parameters
- value: number
  
  the floating point value to add
Returns void

addElement

addElement(node: Json.Node): void

- Defined in Json-1.0.d.ts:1948
Appends the given node inside an array.

Parameters
- node: Json.Node
  
  the element to add
Returns void

addIntElement

addIntElement(value: number): void

- Defined in Json-1.0.d.ts:1955
Conveniently adds the given integer value into an array.

See also: [methodJson.Array.add_element], [methodJson.Node.set_int]

Parameters
- value: number
  
  the integer value to add
Returns void

addNullElement

addNullElement(): void

- Defined in Json-1.0.d.ts:1961
Conveniently adds a null element into an array

See also: [methodJson.Array.add_element], JSON_NODE_NULL

Returns void

addObjectElement

addObjectElement(value: Json.Object): void

- Defined in Json-1.0.d.ts:1970
Conveniently adds an object into an array.

If value is NULL, a null element will be added instead.

See also: [methodJson.Array.add_element], [methodJson.Node.take_object]

Parameters
- value: Json.Object
  
  the object to add
Returns void

addStringElement

addStringElement(value: string): void

- Defined in Json-1.0.d.ts:1977
Conveniently adds the given string value into an array.

See also: [methodJson.Array.add_element], [methodJson.Node.set_string]

Parameters
- value: string
  
  the string value to add
Returns void

dupElement

dupElement(index: number): Json.Node

- Defined in Json-1.0.d.ts:1982
Retrieves a copy of the element at the given position in the array.

Parameters
- index: number
  
  the index of the element to retrieve
Returns Json.Node

equal

equal(b: Json.Array): boolean

- Defined in Json-1.0.d.ts:1992
Check whether two arrays are equal.
Equality is defined as:
- the array have the same number of elements
- the values of elements in corresponding positions are equal
Parameters
- b: Json.Array
  
  another JSON array
Returns boolean

foreachElement

foreachElement(func: ArrayForeach): void

- Defined in Json-1.0.d.ts:2002
Iterates over all elements of an array, and calls a function on each one of them.

It is safe to change the value of an element of the array while iterating over it, but it is not safe to add or remove elements from the array.

Parameters
- func: ArrayForeach
  
  the function to be called on each element
Returns void

getArrayElement

getArrayElement(index: number): Json.Array

- Defined in Json-1.0.d.ts:2009
Conveniently retrieves the array at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_array]

Parameters
- index: number
  
  the index of the element to retrieve
Returns Json.Array

getBooleanElement

getBooleanElement(index: number): boolean

- Defined in Json-1.0.d.ts:2017
Conveniently retrieves the boolean value of the element at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_boolean]

Parameters
- index: number
  
  the index of the element to retrieve
Returns boolean

getDoubleElement

getDoubleElement(index: number): number

- Defined in Json-1.0.d.ts:2025
Conveniently retrieves the floating point value of the element at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_double]

Parameters
- index: number
  
  the index of the element to retrieve
Returns number

getElement

getElement(index: number): Json.Node

- Defined in Json-1.0.d.ts:2030
Retrieves the element at the given position in the array.

Parameters
- index: number
  
  the index of the element to retrieve
Returns Json.Node

getElements

getElements(): Json.Node[]

- Defined in Json-1.0.d.ts:2034
Retrieves all the elements of an array as a list of nodes.

Returns Json.Node[]

getIntElement

getIntElement(index: number): number

- Defined in Json-1.0.d.ts:2042
Conveniently retrieves the integer value of the element at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_int]

Parameters
- index: number
  
  the index of the element to retrieve
Returns number

getLength

getLength(): number

- Defined in Json-1.0.d.ts:2046
Retrieves the length of the given array

Returns number

getNullElement

getNullElement(index: number): boolean

- Defined in Json-1.0.d.ts:2054
Conveniently checks whether the element at the given position inside the array contains a null value.

See also: [methodJson.Array.get_element], [methodJson.Node.is_null]

Parameters
- index: number
  
  the index of the element to retrieve
Returns boolean

getObjectElement

getObjectElement(index: number): Json.Object

- Defined in Json-1.0.d.ts:2061
Conveniently retrieves the object at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_object]

Parameters
- index: number
  
  the index of the element to retrieve
Returns Json.Object

getStringElement

getStringElement(index: number): string

- Defined in Json-1.0.d.ts:2069
Conveniently retrieves the string value of the element at the given position inside an array.

See also: [methodJson.Array.get_element], [methodJson.Node.get_string]

Parameters
- index: number
  
  the index of the element to retrieve
Returns string

hash

hash(): number

- Defined in Json-1.0.d.ts:2078
Calculates a hash value for the given key.

The hash is calculated over the array and all its elements, recursively.

If the array is immutable, this is a fast operation; otherwise, it scales proportionally with the length of the array.

Returns number

isImmutable

isImmutable(): boolean

- Defined in Json-1.0.d.ts:2083
Check whether the given array has been marked as immutable by calling [methodJson.Array.seal] on it.

Returns boolean

ref

ref(): Json.Array

- Defined in Json-1.0.d.ts:2087
Acquires a reference on the given array.

Returns Json.Array

removeElement

removeElement(index: number): void

- Defined in Json-1.0.d.ts:2094
Removes the element at the given position inside an array.

This function will release the reference held on the element.

Parameters
- index: number
  
  the position of the element to be removed
Returns void

seal

seal(): void

- Defined in Json-1.0.d.ts:2102
Seals the given array, making it immutable to further changes.

This function will recursively seal all elements in the array too.

If the array is already immutable, this is a no-op.

Returns void

unref

unref(): void

- Defined in Json-1.0.d.ts:2109
Releases a reference on the given array.

If the reference count reaches zero, the array is destroyed and all its allocated resources are freed.

Returns void

Static new

new(): Json.Array

- Defined in Json-1.0.d.ts:2148
Creates a new array.

Returns Json.Array

Static sizedNew

sizedNew(nElements: number): Json.Array

- Defined in Json-1.0.d.ts:2154
Creates a new array with n_elements slots already allocated.

Parameters
- nElements: number
  
  number of slots to pre-allocate
Returns Json.Array

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Json.Array

Properties

Static name

Methods

addArrayElement

Parameters

value: Json.Array

Returns void

addBooleanElement

Parameters

value: boolean

Returns void

addDoubleElement

Parameters

value: number

Returns void

addElement

Parameters

node: Json.Node

Returns void

addIntElement

Parameters

value: number

Returns void

addNullElement

Returns void

addObjectElement

Parameters

value: Json.Object

Returns void

addStringElement

Parameters

value: string

Returns void

dupElement

Parameters

index: number

Returns Json.Node

equal

Parameters

b: Json.Array

Returns boolean

foreachElement

Parameters

func: ArrayForeach

Returns void

getArrayElement

Parameters

index: number

Returns Json.Array

getBooleanElement

Parameters

index: number

Returns boolean

getDoubleElement

Parameters

index: number

Returns number

getElement

Parameters

index: number

Returns Json.Node

getElements

Returns Json.Node[]

getIntElement

Parameters

index: number

Returns number

getLength

Returns number

getNullElement

Parameters

index: number