Struct TransformResult 

pub struct TransformResult {
    pub code: String,
    pub map: Option<SourceMap>,
    pub declaration: Option<String>,
    pub declaration_map: Option<SourceMap>,
    pub helpers_used: FxHashMap<String, String>,
    pub errors: Vec<OxcError>,
}

Fields

code: String

The transformed code.

If parsing failed, this will be an empty string.

map: Option<SourceMap>

The source map for the transformed code.

This will be set if {@link TransformOptions#sourcemap} is true.

declaration: Option<String>

The .d.ts declaration file for the transformed code. Declarations are only generated if declaration is set to true and a TypeScript file is provided.

If parsing failed and declaration is set, this will be an empty string.

@see {@link TypeScriptOptions#declaration} @see declaration tsconfig option

declaration_map: Option<SourceMap>

Declaration source map. Only generated if both {@link TypeScriptOptions#declaration declaration} and {@link TransformOptions#sourcemap sourcemap} are set to true.

helpers_used: FxHashMap<String, String>

Helpers used.

@internal

Example:

{ "_objectSpread": "@oxc-project/runtime/helpers/objectSpread2" }

errors: Vec<OxcError>

Parse and transformation errors.

Oxc’s parser recovers from common syntax errors, meaning that transformed code may still be available even if there are errors in this list.

Trait Implementations

impl Default for TransformResult

fn default() -> TransformResult

Returns the “default value” for a type.

impl FromNapiValue for TransformResult

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

Safety

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

impl ToNapiValue for TransformResult

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

Safety

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

impl TypeName for TransformResult

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for TransformResult

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

Safety