juce::JSObject Class Reference

A JSObject represents an owning reference to the underlying JS object, meaning it will remain valid even if a subsequent script execution deletes other handles to it. More...

#include <juce_JSObject.h>

Collaboration diagram for juce::JSObject:

Public Member Functions
	JSObject (const JSObject &)
	Copy constructor.
	JSObject (detail::QuickJSWrapper *engine)
	Constructor, used internally by the JavascriptEngine implementation.
	JSObject (JSObject &&) noexcept
	Move constructor.
	~JSObject ()
	Destructor.
var	get () const
	Returns a variant with a value of the property under the given name.
JSObject	getChild (const Identifier &name) const
	Returns a new cursor pointing to a JS object that is a property of the parent cursor's underlying object and has the provided name.
JSObject	getChild (int64 index) const
	Returns a new cursor object pointing to the specified element in an Array.
NamedValueSet	getProperties () const
	Returns all properties of the current object that are own properties, i.e.
int64	getSize () const
	Returns the size of the underlying JS Array.
bool	hasProperty (const Identifier &name) const
	Returns true if the object under the cursor has a property with the given name.
var	invokeMethod (const Identifier &methodName, Span< const var > args, Result *result=nullptr) const
	Invokes this node as though it were a method.
bool	isArray () const
	Returns true if the JS Object under the cursor is an Array.
JSObject &	operator= (const JSObject &)
	Copy assignment operator.
JSObject &	operator= (JSObject &&) noexcept
	Move assignment operator.
JSObject	operator[] (const Identifier &name) const
	Returns a cursor object pointing to the property with the given name.
JSObject	operator[] (int64 index) const
	Returns a new cursor object pointing to the specified element in an Array.
void	setProperty (const Identifier &name, const var &value) const
	Adds a named property to the underlying Object with the provided value, or assigns this value to an existing property with this name.
void	setProperty (int64 index, const var &value) const
	Adds a property with an integral identifier and the provided value to the underlying Object, or assigns the value to an existing property.

Private Member Functions
	JSObject (std::unique_ptr< Impl > implIn)
void	swap (JSObject &other) noexcept

Private Attributes
std::unique_ptr< Impl >	impl

Detailed Description

A JSObject represents an owning reference to the underlying JS object, meaning it will remain valid even if a subsequent script execution deletes other handles to it.

Objects of this class can be used to traverse the current object graph inside the specified Javascript engine.

This is a low-level providing only operations that map directly to the underlying Javascript Object implementation. The JSCursor class generally provides a more convenient interface with functions that may fail based on the Javascript engine's current state.

See also

JSCursor @tags{Core}

Constructor & Destructor Documentation

JSObject() [1/4]

juce::JSObject::JSObject ( detail::QuickJSWrapper *  engine )

explicit

Constructor, used internally by the JavascriptEngine implementation.

To create a new JSObject pointing at the root object of the engine's context use JavascriptEngine::getRootObject().

~JSObject()

juce::JSObject::~JSObject

(

)

Destructor.

JSObject() [2/4]

juce::JSObject::JSObject

(

const JSObject &

)

Copy constructor.

JSObject() [3/4]

juce::JSObject::JSObject ( JSObject &&  )

noexcept

Move constructor.

JSObject() [4/4]

juce::JSObject::JSObject ( std::unique_ptr< Impl >  implIn )

explicitprivate

Member Function Documentation

get()

var juce::JSObject::get

(

)

const

Returns a variant with a value of the property under the given name.

If no such property exists an undefined variant is returned.

If this property points to an object created by JavascriptEngine::registerNativeObject(), then the returned variant will contain a pointer to the original object and can be acquired by variant::getDynamicObject().

getChild() [1/2]

JSObject juce::JSObject::getChild

(

const Identifier &

name

)

const

Returns a new cursor pointing to a JS object that is a property of the parent cursor's underlying object and has the provided name.

You can use hasProperty() to check if such a property exists prior to the creation of this cursor. If no such property exists, this constructor will create a new JS Object and attach it to the parent under the specified name. This can be used to manipulate the object graph.

getChild() [2/2]

JSObject juce::JSObject::getChild

(

int64

index

)

const

Returns a new cursor object pointing to the specified element in an Array.

You must ensure that the cursor points to an Array before calling this function.

See also

isArray

getProperties()

NamedValueSet juce::JSObject::getProperties

(

)

const

Returns all properties of the current object that are own properties, i.e.

not inherited.

getSize()

int64 juce::JSObject::getSize

(

)

const

Returns the size of the underlying JS Array.

You must ensure that the cursor points to an Array before calling this function.

See also

isArray

hasProperty()

bool juce::JSObject::hasProperty

(

const Identifier &

name

)

const

Returns true if the object under the cursor has a property with the given name.

invokeMethod()

var juce::JSObject::invokeMethod	(	const Identifier &	methodName,
		Span< const var >	args,
		Result *	result = nullptr
	)		const

Invokes this node as though it were a method.

If the optional Result pointer is provided it will contain Result::ok() in case of success, or an error message in case an exception was thrown during evaluation.

isArray()

bool juce::JSObject::isArray

(

)

const

Returns true if the JS Object under the cursor is an Array.

You can use getChild() or operator[]() to get a cursor to individual elements in the array or get() to obtain a JUCE variant wrapping all array elements.

operator=() [1/2]

JSObject & juce::JSObject::operator=

(

const JSObject &

)

Copy assignment operator.

operator=() [2/2]

JSObject & juce::JSObject::operator= ( JSObject &&  )

noexcept

Move assignment operator.

operator[]() [1/2]

JSObject juce::JSObject::operator[]

(

const Identifier &

name

)

const

Returns a cursor object pointing to the property with the given name.

If such property doesn't exist it will be created as an empty JS Object. Shorthand for getChild.

operator[]() [2/2]

JSObject juce::JSObject::operator[]

(

int64

index

)

const

Returns a new cursor object pointing to the specified element in an Array.

This function is a shorthand for getChild (int64).

You must ensure that the cursor points to an Array before calling this function.

See also

isArray

setProperty() [1/2]

void juce::JSObject::setProperty	(	const Identifier &	name,
		const var &	value
	)		const

Adds a named property to the underlying Object with the provided value, or assigns this value to an existing property with this name.

setProperty() [2/2]

void juce::JSObject::setProperty	(	int64	index,
		const var &	value
	)		const

Adds a property with an integral identifier and the provided value to the underlying Object, or assigns the value to an existing property.

If the underlying Object is also an Array, then the provided value will be assigned to the specified element of this Array, and ensure that it will have a size of at least index - 1.

swap()

void juce::JSObject::swap ( JSObject &  other )

privatenoexcept

Member Data Documentation

impl

std::unique_ptr<Impl> juce::JSObject::impl

private

---

The documentation for this class was generated from the following file:

• juce_JSObject.h