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 Json-1.0.d.ts:2944
Creates a new object.

Returns Json.Object

Properties

Static name

name: string

Methods

addMember

addMember(memberName: string, node: Json.Node): void

- Defined in Json-1.0.d.ts:2644
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
- memberName: string
  
  the name of the member
- node: Json.Node
  
  the value of the member
Returns void

dupMember

dupMember(memberName: string): Json.Node

- Defined in Json-1.0.d.ts:2649
Retrieves a copy of the value of the given member inside an object.

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

equal

equal(b: Json.Object): boolean

- Defined in Json-1.0.d.ts:2655
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

foreachMember

foreachMember(func: ObjectForeach): void

- Defined in Json-1.0.d.ts:2668
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

getArrayMember

getArrayMember(memberName: string): Json.Array

- Defined in Json-1.0.d.ts:2679
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
- memberName: string
  
  the name of the member
Returns Json.Array

getBooleanMember

getBooleanMember(memberName: string): boolean

- Defined in Json-1.0.d.ts:2689
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
- memberName: string
  
  the name of the member
Returns boolean

getBooleanMemberWithDefault

getBooleanMemberWithDefault(memberName: string, defaultValue: boolean): boolean

- Defined in Json-1.0.d.ts:2699
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
- memberName: string
  
  the name of the object member
- defaultValue: boolean
  
  the value to return if member_name is not valid
Returns boolean

getDoubleMember

getDoubleMember(memberName: string): number

- Defined in Json-1.0.d.ts:2709
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
- memberName: string
  
  the name of the member
Returns number

getDoubleMemberWithDefault

getDoubleMemberWithDefault(memberName: string, defaultValue: number): number

- Defined in Json-1.0.d.ts:2719
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
- memberName: string
  
  the name of the object member
- defaultValue: number
  
  the value to return if member_name is not valid
Returns number

getIntMember

getIntMember(memberName: string): number

- Defined in Json-1.0.d.ts:2729
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
- memberName: string
  
  the name of the object member
Returns number

getIntMemberWithDefault

getIntMemberWithDefault(memberName: string, defaultValue: number): number

- Defined in Json-1.0.d.ts:2739
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
- memberName: string
  
  the name of the object member
- defaultValue: number
  
  the value to return if member_name is not valid
Returns number

getMember

getMember(memberName: string): Json.Node

- Defined in Json-1.0.d.ts:2744
Retrieves the value of the given member inside an object.

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

getMembers

getMembers(): string[]

- Defined in Json-1.0.d.ts:2751
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[]

getNullMember

getNullMember(memberName: string): boolean

- Defined in Json-1.0.d.ts:2760
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
- memberName: string
  
  the name of the member
Returns boolean

getObjectMember

getObjectMember(memberName: string): Json.Object

- Defined in Json-1.0.d.ts:2771
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
- memberName: string
  
  the name of the member
Returns Json.Object

getSize

getSize(): number

- Defined in Json-1.0.d.ts:2775
Retrieves the number of members of a JSON object.

Returns number

getStringMember

getStringMember(memberName: string): string

- Defined in Json-1.0.d.ts:2785
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
- memberName: string
  
  the name of the member
Returns string

getStringMemberWithDefault

getStringMemberWithDefault(memberName: string, defaultValue: string): string

- Defined in Json-1.0.d.ts:2795
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
- memberName: string
  
  the name of the object member
- defaultValue: string
  
  the value to return if member_name is not valid
Returns string

getValues

getValues(): Json.Node[]

- Defined in Json-1.0.d.ts:2799
Retrieves all the values of the members of an object.

Returns Json.Node[]

hasMember

hasMember(memberName: string): boolean

- Defined in Json-1.0.d.ts:2804
Checks whether object has a member named member_name.

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

hash

hash(): number

- Defined in Json-1.0.d.ts:2812
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

isImmutable

isImmutable(): boolean

- Defined in Json-1.0.d.ts:2817
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 Json-1.0.d.ts:2821
Acquires a reference on the given object.

Returns Json.Object

removeMember

removeMember(memberName: string): void

- Defined in Json-1.0.d.ts:2826
Removes member_name from object, freeing its allocated resources.

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

seal

seal(): void

- Defined in Json-1.0.d.ts:2834
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

setArrayMember

setArrayMember(memberName: string, value: Json.Array): void

- Defined in Json-1.0.d.ts:2842
Convenience function for setting an object member with an array value.

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

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

setBooleanMember

setBooleanMember(memberName: string, value: boolean): void

- Defined in Json-1.0.d.ts:2850
Convenience function for setting an object member with a boolean value.

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

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

setDoubleMember

setDoubleMember(memberName: string, value: number): void

- Defined in Json-1.0.d.ts:2858
Convenience function for setting an object member with a floating point value.

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

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

setIntMember

setIntMember(memberName: string, value: number): void

- Defined in Json-1.0.d.ts:2866
Convenience function for setting an object member with an integer value.

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

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

setMember

setMember(memberName: string, node: Json.Node): void

- Defined in Json-1.0.d.ts:2878
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
- memberName: string
  
  the name of the member
- node: Json.Node
  
  the value of the member
Returns void

setNullMember

setNullMember(memberName: string): void

- Defined in Json-1.0.d.ts:2885
Convenience function for setting an object member with a null value.

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

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

setObjectMember

setObjectMember(memberName: string, value: Json.Object): void

- Defined in Json-1.0.d.ts:2893
Convenience function for setting an object member with an object value.

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

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

setStringMember

setStringMember(memberName: string, value: string): void

- Defined in Json-1.0.d.ts:2901
Convenience function for setting an object member with a string value.

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

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

unref

unref(): void

- Defined in Json-1.0.d.ts:2908
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 Json-1.0.d.ts:2949
Creates a new object.

Returns Json.Object

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Json.Object

Properties

Static name

Methods

addMember

Parameters

memberName: string

node: Json.Node

Returns void

dupMember

Parameters

memberName: string

Returns Json.Node

equal

Parameters

b: Json.Object

Returns boolean

foreachMember

Parameters

func: ObjectForeach

Returns void

getArrayMember

Parameters

memberName: string

Returns Json.Array

getBooleanMember

Parameters

memberName: string

Returns boolean

getBooleanMemberWithDefault

Parameters

memberName: string

defaultValue: boolean

Returns boolean

getDoubleMember

Parameters

memberName: string

Returns number

getDoubleMemberWithDefault

Parameters

memberName: string

defaultValue: number

Returns number

getIntMember

Parameters

memberName: string

Returns number

getIntMemberWithDefault

Parameters

memberName: string

defaultValue: number

Returns number

getMember

Parameters

memberName: string

Returns Json.Node

getMembers

Returns string[]

getNullMember

Parameters

memberName: string

Returns boolean

getObjectMember

Parameters

memberName: string

Returns Json.Object

getSize

Returns number

getStringMember

Parameters

memberName: string

Returns string

getStringMemberWithDefault