Struct JsObject

pub struct JsObject(/* private fields */);

Implementations

impl JsObject

pub fn new(env: NapiEnv) -> NapiResult<JsObject>

pub fn set_named_property( &mut self, key: impl AsRef<str>, value: impl NapiValueT, ) -> NapiResult<()>

This method is equivalent to calling napi_get_property with a napi_value created from the string passed in as utf8Name.

pub fn get_property_names(&self) -> NapiResult<JsArray>

This API returns the names of the enumerable properties of object as an array of strings. The properties of object whose key is a symbol will not be included.

pub fn get_all_property_names( &self, mode: NapiKeyCollectionMode, filter: NapiKeyFilter, conversion: NapiKeyConversion, ) -> NapiResult<JsArray>

This API returns an array containing the names of the available properties of this object.

pub fn set<T: NapiValueT>( &mut self, key: impl AsRef<str>, value: T, ) -> NapiResult<()>

Set value by string-like key.

pub fn set_property( &mut self, key: impl NapiValueT, value: impl NapiValueT, ) -> NapiResult<()>

This API set a property on the Object passed in.

pub fn get_property(&self, key: impl NapiValueT) -> NapiResult<JsValue>

This API gets the requested property from the Object passed in.

pub unsafe fn get_unchecked<T: NapiValueT>( &self, key: impl AsRef<str>, ) -> NapiResult<T>

Get value by string-like key.

Safety

This function just put napi handle in struct T without any check. It is your duty to make sure the origin value is really type of T.

pub fn get<T: NapiValueT>(&self, key: impl AsRef<str>) -> NapiResult<T>

Get value by string-like key.

pub fn has_property(&self, key: impl NapiValueT) -> NapiResult<bool>

This API checks if the Object passed in has the named property.

pub fn delete_property(&self, key: impl NapiValueT) -> NapiResult<bool>

This API attempts to delete the key own property from object.

pub fn has_own_property( &mut self, key: impl NapiValueT, value: impl NapiValueT, ) -> NapiResult<bool>

This API checks if the Object passed in has the named own property. key must be a string or a symbol, or an error will be thrown. Node-API will not perform any conversion between data types.

pub fn get_named_property(&self, key: impl AsRef<str>) -> NapiResult<JsValue>

This method is equivalent to calling napi_get_property with a napi_value created from the string passed in as utf8Name.

pub fn has_named_property(&self, key: impl AsRef<str>) -> NapiResult<bool>

This method is equivalent to calling napi_has_property with a napi_value created from the string passed in as utf8Name.

pub fn set_element( &mut self, index: u32, value: impl NapiValueT, ) -> NapiResult<()>

This API sets an element on the Object passed in.

pub fn get_element(&mut self, index: u32) -> NapiResult<JsValue>

This API gets the element at the requested index.

pub fn has_element(&mut self, index: u32) -> NapiResult<bool>

This API returns if the Object passed in has an element at the requested index.

pub fn delete_element(&mut self, index: u32) -> NapiResult<bool>

This API attempts to delete the specified index from object.

pub fn freeze(&mut self) -> NapiResult<()>

Object.freeze()

pub fn seal(&mut self) -> NapiResult<()>

Object.seal()

Trait Implementations

impl Clone for JsObject

fn clone(&self) -> JsObject

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl NapiValueCheck for JsObject

fn check(&self) -> NapiResult<bool>

impl NapiValueT for JsObject

fn from_raw(env: NapiEnv, raw: napi_value) -> JsObject

construct value from raw pointer

fn value(&self) -> JsValue

inner value

unsafe fn cast<T: NapiValueT>(&self) -> T

napi_value type cast

fn cast_checked<T: NapiValueT>(&self) -> NapiResult<T>

Upcast to specified value

fn kind(&self) -> NapiResult<NapiValuetype>

Returns napi_ok if the API succeeded.

fn coerce_to_bool(&self) -> NapiResult<JsBoolean>

This API implements the abstract operation ToBoolean() as defined in Section 7.1.2 of the ECMAScript Language Specification.

fn coerce_coerce_to_number(&self) -> NapiResult<JsNumber>

This API implements the abstract operation ToNumber() as defined in Section 7.1.3 of the ECMAScript Language Specification. This function potentially runs JS code if the passed-in value is an object.

fn coerce_to_object(&self) -> NapiResult<JsObject>

This API implements the abstract operation ToObject() as defined in Section 7.1.13 of the ECMAScript Language Specification.

fn coerce_to_string(&self) -> NapiResult<JsString>

This API implements the abstract operation ToString() as defined in Section 7.1.13 of the ECMAScript Language Specification. This function potentially runs JS code if the passed-in value is an object.

fn instance_of(&self, constructor: JsFunction) -> NapiResult<bool>

This API represents invoking the instanceof Operator on the object as defined in Section 12.10.4 of the ECMAScript Language Specification.

fn equals(&self, rhs: impl NapiValueT) -> NapiResult<bool>

This API represents the invocation of the Strict Equality algorithm as defined in Section 7.2.14 of the ECMAScript Language Specification.

fn env(&self) -> NapiEnv

the NapiEnv of current value

fn raw(&self) -> napi_value

the raw-handle of current value

fn null(&self) -> NapiResult<JsNull>

get null singleton

fn undefined(&self) -> NapiResult<JsUndefined>

get undefined singleton

fn global(&self) -> NapiResult<JsGlobal>

get global singleton

fn throw(&self) -> NapiResult<()>

value is throwable

fn define_properties<P>(&self, properties: P) -> NapiResult<()>

where P: AsRef<[NapiPropertyDescriptor]>,

This method allows the efficient definition of multiple properties on a given object. The properties are defined using property descriptors (see napi_property_descriptor). Given an array of such property descriptors, this API will set the properties on the object one at a time, as defined by DefineOwnProperty() (described in Section 9.1.6 of the ECMA-262 specification).

fn gc<Finalizer>(&mut self, finalizer: Finalizer) -> NapiResult<NapiRef>

where Finalizer: FnOnce(NapiEnv) -> NapiResult<()>,

This is a hook which is fired when the value is gabage-collected. For napi >= 5, we use napi_add_finalizer, For napi < 5, we use napi_wrap.

fn finalizer<Finalizer>(&self, finalizer: Finalizer) -> NapiResult<NapiRef>

where Finalizer: FnOnce(NapiEnv) -> NapiResult<()>,

Adds a napi_finalize callback which will be called when the JavaScript object in js_object is ready for garbage collection. This API is similar to napi_wrap() except that:

fn wrap<T>( &mut self, data: T, finalizer: impl FnOnce(NapiEnv, T) -> NapiResult<()>, ) -> NapiResult<NapiRef>

Wraps a native instance in a JavaScript object. The native instance can be retrieved later using napi_unwrap().

fn unwrap<T>(&self) -> NapiResult<Option<&mut T>>

Retrieves a native instance that was previously wrapped in a JavaScript object using napi_wrap().

fn remove_wrap<T>(&mut self) -> NapiResult<T>

Retrieves a native instance that was previously wrapped in the JavaScript object js_object using napi_wrap() and removes the wrapping. If a finalize callback was associated with the wrapping, it will no longer be called when the JavaScript object becomes garbage-collected.

fn type_tag_object(&self, tag: &NapiTypeTag) -> NapiResult<()>

Associates the value of the type_tag pointer with the JavaScript object. napi_check_object_type_tag() can then be used to compare the tag that was attached to the object with one owned by the addon to ensure that the object has the right type. If the object already has an associated type tag, this API will return napi_invalid_arg.

fn check_object_type_tag(&self, tag: &NapiTypeTag) -> NapiResult<bool>

Compares the pointer given as type_tag with any that can be found on js_object. If no tag is found on js_object or, if a tag is found but it does not match type_tag, then result is set to false. If a tag is found and it matches type_tag, then result is set to true.

impl Copy for JsObject