Struct nodex_api::value::JsObject

pub struct JsObject(_);

Implementations

impl JsObject

pub fn napi_module_exports(env: napi_env, value: napi_value) -> JsObject

NB: This is a special JsObject that should only be used in napi_register_module_v1.

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 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 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.

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 NapiValueT for JsObject

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

construct value from raw pointer

fn value(&self) -> JsValue

inner value

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

napi_value type cast

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 is_array(&self) -> NapiResult<bool>

This API represents invoking the IsArray operation on the object as defined in Section 7.2.2 of the ECMAScript Language Specification.

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

This API checks if the Object passed in is an array buffer.

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

This API checks if the Object passed in is a buffer.

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

This API checks if the Object passed in is a error.

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

This API checks if the Object passed in is a typed array.

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

This API checks if the Object passed in is a DataView.

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 kind(&self) -> NapiResult<NapiValuetype>

Returns napi_ok if the API succeeded.

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 wrap<T, Finalizer>(
    &mut self,
    data: T,
    finalizer: Finalizer
) -> NapiResult<NapiRef> where
    Finalizer: FnOnce(NapiEnv, T) -> NapiResult<()>, 

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

fn unwrap<T>(&self) -> NapiResult<Option<&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.

impl Copy for JsObject