Struct TypeScriptOptions 

pub struct TypeScriptOptions {
    pub jsx_pragma: Option<String>,
    pub jsx_pragma_frag: Option<String>,
    pub only_remove_type_imports: Option<bool>,
    pub allow_namespaces: Option<bool>,
    pub allow_declare_fields: Option<bool>,
    pub remove_class_fields_without_initializer: Option<bool>,
    pub declaration: Option<IsolatedDeclarationsOptions>,
    pub rewrite_import_extensions: Option<Either<bool, String>>,
}

Fields

jsx_pragma: Option<String>

jsx_pragma_frag: Option<String>

only_remove_type_imports: Option<bool>

allow_namespaces: Option<bool>

allow_declare_fields: Option<bool>

When enabled, type-only class fields are only removed if they are prefixed with the declare modifier:

@deprecated

Allowing declare fields is built-in support in Oxc without any option. If you want to remove class fields without initializer, you can use remove_class_fields_without_initializer: true instead.

remove_class_fields_without_initializer: Option<bool>

When enabled, class fields without initializers are removed.

For example:

class Foo {
   x: number;
   y: number = 0;
}

// transform into

class Foo {
   x: number;
}

The option is used to align with the behavior of TypeScript’s useDefineForClassFields: false option. When you want to enable this, you also need to set crate::CompilerAssumptions::set_public_class_fields to true. The set_public_class_fields: true + remove_class_fields_without_initializer: true is equivalent to useDefineForClassFields: false in TypeScript.

When set_public_class_fields is true and class-properties plugin is enabled, the above example transforms into:

class Foo {
  constructor() {
    this.y = 0;
  }
}

Defaults to false.

declaration: Option<IsolatedDeclarationsOptions>

Also generate a .d.ts declaration file for TypeScript files.

The source file must be compliant with all isolatedDeclarations requirements.

@default false

rewrite_import_extensions: Option<Either<bool, String>>

Rewrite or remove TypeScript import/export declaration extensions.

• When set to rewrite, it will change .ts, .mts, .cts extensions to .js, .mjs, .cjs respectively.
• When set to remove, it will remove .ts/.mts/.cts/.tsx extension entirely.
• When set to true, it’s equivalent to rewrite.
• When set to false or omitted, no changes will be made to the extensions.

@default false

Trait Implementations

impl Default for TypeScriptOptions

fn default() -> TypeScriptOptions

Returns the “default value” for a type.

impl From<TypeScriptOptions> for TypeScriptOptions

fn from(options: TypeScriptOptions) -> Self

Converts to this type from the input type.

impl FromNapiValue for TypeScriptOptions

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

Safety

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

impl ToNapiValue for TypeScriptOptions

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

Safety

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

impl TypeName for TypeScriptOptions

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for TypeScriptOptions

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

Safety