Struct TransformOptions 

pub struct TransformOptions {

    pub lang: Option<String>,
    pub source_type: Option<String>,
    pub cwd: Option<String>,
    pub sourcemap: Option<bool>,
    pub assumptions: Option<CompilerAssumptions>,
    pub typescript: Option<TypeScriptOptions>,
    pub jsx: Option<Either<String, JsxOptions>>,
    pub target: Option<Either<String, Vec<String>>>,
    pub helpers: Option<Helpers>,
    pub define: Option<FxHashMap<String, String>>,
    pub inject: Option<FxHashMap<String, Either<String, Vec<String>>>>,
    pub decorator: Option<DecoratorOptions>,
    pub plugins: Option<PluginsOptions>,
}

Options for transforming a JavaScript or TypeScript file.

@see {@link transform}

Fields

lang: Option<String>

Treat the source text as js, jsx, ts, tsx, or dts.

source_type: Option<String>

Treat the source text as script or module code.

cwd: Option<String>

The current working directory. Used to resolve relative paths in other options.

sourcemap: Option<bool>

Enable source map generation.

When true, the sourceMap field of transform result objects will be populated.

@default false

@see {@link SourceMap}

assumptions: Option<CompilerAssumptions>

Set assumptions in order to produce smaller output.

typescript: Option<TypeScriptOptions>

Configure how TypeScript is transformed. @see {@link https://oxc.rs/docs/guide/usage/transformer/typescript}

jsx: Option<Either<String, JsxOptions>>

Configure how TSX and JSX are transformed. @see {@link https://oxc.rs/docs/guide/usage/transformer/jsx}

target: Option<Either<String, Vec<String>>>

Sets the target environment for the generated JavaScript.

The lowest target is es2015.

Example:

• 'es2015'
• ['es2020', 'chrome58', 'edge16', 'firefox57', 'node12', 'safari11']

@default esnext (No transformation)

@see {@link https://oxc.rs/docs/guide/usage/transformer/lowering#target}

helpers: Option<Helpers>

Behaviour for runtime helpers.

define: Option<FxHashMap<String, String>>

Define Plugin @see {@link https://oxc.rs/docs/guide/usage/transformer/global-variable-replacement#define}

inject: Option<FxHashMap<String, Either<String, Vec<String>>>>

Inject Plugin @see {@link https://oxc.rs/docs/guide/usage/transformer/global-variable-replacement#inject}

decorator: Option<DecoratorOptions>

Decorator plugin

plugins: Option<PluginsOptions>

Third-party plugins to use. @see {@link https://oxc.rs/docs/guide/usage/transformer/plugins}

Trait Implementations

impl Default for TransformOptions

fn default() -> TransformOptions

Returns the “default value” for a type.

impl FromNapiValue for TransformOptions

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

Safety

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

impl ToNapiValue for TransformOptions

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

Safety

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

impl TryFrom<TransformOptions> for TransformOptions

type Error = String

The type returned in the event of a conversion error.

fn try_from(options: TransformOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl TypeName for TransformOptions

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for TransformOptions

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

Safety