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 @types/Gjs/Json-1.0.d.ts:2184
Creates a new array.

Returns Json.Array

Properties

Static name

name: string

Methods

add_array_element

add_array_element(value: Json.Array): void

- Defined in @types/Gjs/Json-1.0.d.ts:1970
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

add_boolean_element

add_boolean_element(value: boolean): void

- Defined in @types/Gjs/Json-1.0.d.ts:1977
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

add_double_element

add_double_element(value: number): void

- Defined in @types/Gjs/Json-1.0.d.ts:1984
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

add_element

add_element(node: Json.Node): void

- Defined in @types/Gjs/Json-1.0.d.ts:1989
Appends the given node inside an array.

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

add_int_element

add_int_element(value: number): void

- Defined in @types/Gjs/Json-1.0.d.ts:1996
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

add_null_element

add_null_element(): void

- Defined in @types/Gjs/Json-1.0.d.ts:2002
Conveniently adds a null element into an array

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

Returns void

add_object_element

add_object_element(value: Json.Object): void

- Defined in @types/Gjs/Json-1.0.d.ts:2011
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

add_string_element

add_string_element(value: string): void

- Defined in @types/Gjs/Json-1.0.d.ts:2018
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

dup_element

dup_element(index_: number): Json.Node

- Defined in @types/Gjs/Json-1.0.d.ts:2023
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 @types/Gjs/Json-1.0.d.ts:2033
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

foreach_element

foreach_element(func: ArrayForeach): void

- Defined in @types/Gjs/Json-1.0.d.ts:2043
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

get_array_element

get_array_element(index_: number): Json.Array

- Defined in @types/Gjs/Json-1.0.d.ts:2050
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

get_boolean_element

get_boolean_element(index_: number): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2058
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

get_double_element

get_double_element(index_: number): number

- Defined in @types/Gjs/Json-1.0.d.ts:2066
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

get_element

get_element(index_: number): Json.Node

- Defined in @types/Gjs/Json-1.0.d.ts:2071
Retrieves the element at the given position in the array.

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

get_elements

get_elements(): Json.Node[]

- Defined in @types/Gjs/Json-1.0.d.ts:2075
Retrieves all the elements of an array as a list of nodes.

Returns Json.Node[]

get_int_element

get_int_element(index_: number): number

- Defined in @types/Gjs/Json-1.0.d.ts:2083
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

get_length

get_length(): number

- Defined in @types/Gjs/Json-1.0.d.ts:2087
Retrieves the length of the given array

Returns number

get_null_element

get_null_element(index_: number): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2095
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

get_object_element

get_object_element(index_: number): Json.Object

- Defined in @types/Gjs/Json-1.0.d.ts:2102
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

get_string_element

get_string_element(index_: number): string

- Defined in @types/Gjs/Json-1.0.d.ts:2110
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 @types/Gjs/Json-1.0.d.ts:2119
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

is_immutable

is_immutable(): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2124
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 @types/Gjs/Json-1.0.d.ts:2128
Acquires a reference on the given array.

Returns Json.Array

remove_element

remove_element(index_: number): void

- Defined in @types/Gjs/Json-1.0.d.ts:2135
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 @types/Gjs/Json-1.0.d.ts:2143
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 @types/Gjs/Json-1.0.d.ts:2150
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 @types/Gjs/Json-1.0.d.ts:2189
Creates a new array.

Returns Json.Array

Static sized_new

sized_new(n_elements: number): Json.Array

- Defined in @types/Gjs/Json-1.0.d.ts:2195
Creates a new array with n_elements slots already allocated.

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Json.Array

Properties

Static name

Methods

add_array_element

Parameters

value: Json.Array

Returns void

add_boolean_element

Parameters

value: boolean

Returns void

add_double_element

Parameters

value: number

Returns void

add_element

Parameters

node: Json.Node

Returns void

add_int_element

Parameters

value: number

Returns void

add_null_element

Returns void

add_object_element

Parameters

value: Json.Object

Returns void

add_string_element

Parameters

value: string

Returns void

dup_element

Parameters

index_: number

Returns Json.Node

equal

Parameters

b: Json.Array

Returns boolean

foreach_element

Parameters

func: ArrayForeach

Returns void

get_array_element

Parameters

index_: number

Returns Json.Array

get_boolean_element

Parameters

index_: number

Returns boolean

get_double_element

Parameters

index_: number

Returns number

get_element

Parameters

index_: number

Returns Json.Node

get_elements

Returns Json.Node[]

get_int_element

Parameters

index_: number

Returns number

get_length

Returns number

get_null_element

Parameters

index_: number