Struct TreeShakeOptions 

pub struct TreeShakeOptions {
    pub annotations: Option<bool>,
    pub manual_pure_functions: Option<Vec<String>>,
    pub property_read_side_effects: Option<Either<bool, String>>,
    pub property_write_side_effects: Option<bool>,
    pub unknown_global_side_effects: Option<bool>,
    pub invalid_import_side_effects: Option<bool>,
}

Fields

annotations: Option<bool>

Whether to respect the pure annotations.

Pure annotations are comments that mark an expression as pure. For example: @PURE or #NO_SIDE_EFFECTS.

@default true

manual_pure_functions: Option<Vec<String>>

Whether to treat this function call as pure.

This function is called for normal function calls, new calls, and tagged template calls.

property_read_side_effects: Option<Either<bool, String>>

Whether property read accesses have side effects.

@default ‘always’

property_write_side_effects: Option<bool>

Whether property write accesses (assignments to member expressions) have side effects.

When false, assignments like obj.prop = value are considered side-effect-free (assuming the object and value expressions themselves are side-effect-free).

@default true

unknown_global_side_effects: Option<bool>

Whether accessing a global variable has side effects.

Accessing a non-existing global variable will throw an error. Global variable may be a getter that has side effects.

@default true

invalid_import_side_effects: Option<bool>

Whether invalid import statements have side effects.

Accessing a non-existing import name will throw an error. Also import statements that cannot be resolved will throw an error.

@default true

Trait Implementations

impl FromNapiValue for TreeShakeOptions

unsafe fn from_napi_value( env: napi_env, napi_val: napi_value, ) -> Result<TreeShakeOptions>

This function called to convert napi values to native rust values

fn from_unknown(value: Unknown<'_>) -> Result<Self, Error>

impl ToNapiValue for TreeShakeOptions

unsafe fn to_napi_value( env: napi_env, val: TreeShakeOptions, ) -> Result<napi_value>

This function called to convert rust values to napi values

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>, Error>

impl TryFrom<&TreeShakeOptions> for TreeShakeOptions

type Error = String

The type returned in the event of a conversion error.

fn try_from(o: &TreeShakeOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeName for TreeShakeOptions

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for TreeShakeOptions

unsafe fn validate( env: *mut napi_env__, napi_val: *mut napi_value__, ) -> Result<*mut napi_value__, Error>

This function called to validate whether napi value passed to rust is valid type.