Class Object

JsonObject is the representation of the object type inside JSON.

A JsonObject contains [structJson.Node] "members", which may contain fundamental types, arrays or other objects; each member of an object is accessed using a unique string, or "name".

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

To add or overwrite a member with a given name, use [methodJson.Object.set_member].

To extract a member with a given name, use [methodJson.Object.get_member].

To retrieve the list of members, use [methodJson.Object.get_members].

To retrieve the size of the object (that is, the number of members it has), use [methodJson.Object.get_size].

record

Hierarchy

Object

Constructors

constructor

new Object(): Json.Object

- Defined in @types/Gjs/Json-1.0.d.ts:2985
Creates a new object.

Returns Json.Object

Properties

Static name

name: string

Methods

add_member

add_member(member_name: string, node: Json.Node): void

- Defined in @types/Gjs/Json-1.0.d.ts:2685
Adds a new member for the given name and value into an object.

This function will return if the object already contains a member with the same name.

Parameters
- member_name: string
  
  the name of the member
- node: Json.Node
  
  the value of the member
Returns void

dup_member

dup_member(member_name: string): Json.Node

- Defined in @types/Gjs/Json-1.0.d.ts:2690
Retrieves a copy of the value of the given member inside an object.

Parameters
- member_name: string
  
  the name of the JSON object member to access
Returns Json.Node

equal

equal(b: Json.Object): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2696
Check whether a and b are equal objects, meaning they have the same set of members, and the values of corresponding members are equal.

Parameters
- b: Json.Object
  
  another JSON object
Returns boolean

foreach_member

foreach_member(func: ObjectForeach): void

- Defined in @types/Gjs/Json-1.0.d.ts:2709
Iterates over all members of object and calls func on each one of them.

It is safe to change the value of a member of the oobject from within the iterator function, but it is not safe to add or remove members from the object.

The order in which the object members are iterated is the insertion order.

Parameters
- func: ObjectForeach
  
  the function to be called on each member
Returns void

get_array_member

get_array_member(member_name: string): Json.Array

- Defined in @types/Gjs/Json-1.0.d.ts:2720
Convenience function that retrieves the array stored in member_name of object. It is an error to specify a member_name which does not exist.

If member_name contains null, then this function will return NULL.

See also: [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns Json.Array

get_boolean_member

get_boolean_member(member_name: string): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2730
Convenience function that retrieves the boolean value stored in member_name of object. It is an error to specify a member_name which does not exist.

See also: [methodJson.Object.get_boolean_member_with_default], [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns boolean

get_boolean_member_with_default

get_boolean_member_with_default(member_name: string, default_value: boolean): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2740
Convenience function that retrieves the boolean value stored in member_name of object.

If member_name does not exist, does not contain a scalar value, or contains null, then default_value is returned instead.

Parameters
- member_name: string
  
  the name of the object member
- default_value: boolean
  
  the value to return if member_name is not valid
Returns boolean

get_double_member

get_double_member(member_name: string): number

- Defined in @types/Gjs/Json-1.0.d.ts:2750
Convenience function that retrieves the floating point value stored in member_name of object. It is an error to specify a member_name which does not exist.

See also: [methodJson.Object.get_double_member_with_default], [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns number

get_double_member_with_default

get_double_member_with_default(member_name: string, default_value: number): number

- Defined in @types/Gjs/Json-1.0.d.ts:2760
Convenience function that retrieves the floating point value stored in member_name of object.

If member_name does not exist, does not contain a scalar value, or contains null, then default_value is returned instead.

Parameters
- member_name: string
  
  the name of the object member
- default_value: number
  
  the value to return if member_name is not valid
Returns number

get_int_member

get_int_member(member_name: string): number

- Defined in @types/Gjs/Json-1.0.d.ts:2770
Convenience function that retrieves the integer value stored in member_name of object. It is an error to specify a member_name which does not exist.

See also: [methodJson.Object.get_int_member_with_default], [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the object member
Returns number

get_int_member_with_default

get_int_member_with_default(member_name: string, default_value: number): number

- Defined in @types/Gjs/Json-1.0.d.ts:2780
Convenience function that retrieves the integer value stored in member_name of object.

If member_name does not exist, does not contain a scalar value, or contains null, then default_value is returned instead.

Parameters
- member_name: string
  
  the name of the object member
- default_value: number
  
  the value to return if member_name is not valid
Returns number

get_member

get_member(member_name: string): Json.Node

- Defined in @types/Gjs/Json-1.0.d.ts:2785
Retrieves the value of the given member inside an object.

Parameters
- member_name: string
  
  the name of the JSON object member to access
Returns Json.Node

get_members

get_members(): string[]

- Defined in @types/Gjs/Json-1.0.d.ts:2792
Retrieves all the names of the members of an object.

You can obtain the value for each member by iterating the returned list and calling [methodJson.Object.get_member].

Returns string[]

get_null_member

get_null_member(member_name: string): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2801
Convenience function that checks whether the value stored in member_name of object is null. It is an error to specify a member_name which does not exist.

See also: [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns boolean

get_object_member

get_object_member(member_name: string): Json.Object

- Defined in @types/Gjs/Json-1.0.d.ts:2812
Convenience function that retrieves the object stored in member_name of object. It is an error to specify a member_name which does not exist.

If member_name contains null, then this function will return NULL.

See also: [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns Json.Object

get_size

get_size(): number

- Defined in @types/Gjs/Json-1.0.d.ts:2816
Retrieves the number of members of a JSON object.

Returns number

get_string_member

get_string_member(member_name: string): string

- Defined in @types/Gjs/Json-1.0.d.ts:2826
Convenience function that retrieves the string value stored in member_name of object. It is an error to specify a member_name that does not exist.

See also: [methodJson.Object.get_string_member_with_default], [methodJson.Object.get_member], [methodJson.Object.has_member]

Parameters
- member_name: string
  
  the name of the member
Returns string

get_string_member_with_default

get_string_member_with_default(member_name: string, default_value: string): string

- Defined in @types/Gjs/Json-1.0.d.ts:2836
Convenience function that retrieves the string value stored in member_name of object.

If member_name does not exist, does not contain a scalar value, or contains null, then default_value is returned instead.

Parameters
- member_name: string
  
  the name of the object member
- default_value: string
  
  the value to return if member_name is not valid
Returns string

get_values

get_values(): Json.Node[]

- Defined in @types/Gjs/Json-1.0.d.ts:2840
Retrieves all the values of the members of an object.

Returns Json.Node[]

has_member

has_member(member_name: string): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2845
Checks whether object has a member named member_name.

Parameters
- member_name: string
  
  the name of a JSON object member
Returns boolean

hash

hash(): number

- Defined in @types/Gjs/Json-1.0.d.ts:2853
Calculate a hash value for the given key (a JSON object).

The hash is calculated over the object and all its members, recursively. If the object is immutable, this is a fast operation; otherwise, it scales proportionally with the number of members in the object.

Returns number

is_immutable

is_immutable(): boolean

- Defined in @types/Gjs/Json-1.0.d.ts:2858
Checks whether the given object has been marked as immutable by calling [methodJson.Object.seal] on it.

Returns boolean

ref

ref(): Json.Object

- Defined in @types/Gjs/Json-1.0.d.ts:2862
Acquires a reference on the given object.

Returns Json.Object

remove_member

remove_member(member_name: string): void

- Defined in @types/Gjs/Json-1.0.d.ts:2867
Removes member_name from object, freeing its allocated resources.

Parameters
- member_name: string
  
  the name of the member to remove
Returns void

seal

seal(): void

- Defined in @types/Gjs/Json-1.0.d.ts:2875
Seals the object, making it immutable to further changes.

This function will recursively seal all members of the object too.

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

Returns void

set_array_member

set_array_member(member_name: string, value: Json.Array): void

- Defined in @types/Gjs/Json-1.0.d.ts:2883
Convenience function for setting an object member with an array value.

See also: [methodJson.Object.set_member], [methodJson.Node.take_array]

Parameters
- member_name: string
  
  the name of the member
- value: Json.Array
  
  the value of the member
Returns void

set_boolean_member

set_boolean_member(member_name: string, value: boolean): void

- Defined in @types/Gjs/Json-1.0.d.ts:2891
Convenience function for setting an object member with a boolean value.

See also: [methodJson.Object.set_member], [methodJson.Node.init_boolean]

Parameters
- member_name: string
  
  the name of the member
- value: boolean
  
  the value of the member
Returns void

set_double_member

set_double_member(member_name: string, value: number): void

- Defined in @types/Gjs/Json-1.0.d.ts:2899
Convenience function for setting an object member with a floating point value.

See also: [methodJson.Object.set_member], [methodJson.Node.init_double]

Parameters
- member_name: string
  
  the name of the member
- value: number
  
  the value of the member
Returns void

set_int_member

set_int_member(member_name: string, value: number): void

- Defined in @types/Gjs/Json-1.0.d.ts:2907
Convenience function for setting an object member with an integer value.

See also: [methodJson.Object.set_member], [methodJson.Node.init_int]

Parameters
- member_name: string
  
  the name of the member
- value: number
  
  the value of the member
Returns void

set_member

set_member(member_name: string, node: Json.Node): void

- Defined in @types/Gjs/Json-1.0.d.ts:2919
Sets the value of a member inside an object.

If the object does not have a member with the given name, a new member is created.

If the object already has a member with the given name, the current value is overwritten with the new.

Parameters
- member_name: string
  
  the name of the member
- node: Json.Node
  
  the value of the member
Returns void

set_null_member

set_null_member(member_name: string): void

- Defined in @types/Gjs/Json-1.0.d.ts:2926
Convenience function for setting an object member with a null value.

See also: [methodJson.Object.set_member], [methodJson.Node.init_null]

Parameters
- member_name: string
  
  the name of the member
Returns void

set_object_member

set_object_member(member_name: string, value: Json.Object): void

- Defined in @types/Gjs/Json-1.0.d.ts:2934
Convenience function for setting an object member with an object value.

See also: [methodJson.Object.set_member], [methodJson.Node.take_object]

Parameters
- member_name: string
  
  the name of the member
- value: Json.Object
  
  the value of the member
Returns void

set_string_member

set_string_member(member_name: string, value: string): void

- Defined in @types/Gjs/Json-1.0.d.ts:2942
Convenience function for setting an object member with a string value.

See also: [methodJson.Object.set_member], [methodJson.Node.init_string]

Parameters
- member_name: string
  
  the name of the member
- value: string
  
  the value of the member
Returns void

unref

unref(): void

- Defined in @types/Gjs/Json-1.0.d.ts:2949
Releases a reference on the given object.

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

Returns void

Static new

new(): Json.Object

- Defined in @types/Gjs/Json-1.0.d.ts:2990
Creates a new object.

Returns Json.Object

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Json.Object

Properties

Static name

Methods

add_member

Parameters

member_name: string

node: Json.Node

Returns void

dup_member

Parameters

member_name: string

Returns Json.Node

equal

Parameters

b: Json.Object

Returns boolean

foreach_member

Parameters

func: ObjectForeach

Returns void

get_array_member

Parameters

member_name: string

Returns Json.Array

get_boolean_member

Parameters

member_name: string

Returns boolean

get_boolean_member_with_default

Parameters

member_name: string

default_value: boolean

Returns boolean

get_double_member

Parameters

member_name: string

Returns number

get_double_member_with_default

Parameters

member_name: string

default_value: number

Returns number

get_int_member

Parameters

member_name: string

Returns number

get_int_member_with_default

Parameters

member_name: string

default_value: number

Returns number

get_member

Parameters

member_name: string

Returns Json.Node

get_members

Returns string[]

get_null_member

Parameters

member_name: string

Returns boolean

get_object_member

Parameters

member_name: string

Returns Json.Object

get_size

Returns number

get_string_member

Parameters

member_name: string

Returns string

get_string_member_with_default