Struct TypeScriptOptions

pub struct TypeScriptOptions {
    pub jsx_pragma: Cow<'static, str>,
    pub jsx_pragma_frag: Cow<'static, str>,
    pub only_remove_type_imports: bool,
    pub allow_namespaces: bool,
    pub allow_declare_fields: bool,
    pub remove_class_fields_without_initializer: bool,
    pub optimize_const_enums: bool,
    pub rewrite_import_extensions: Option<RewriteExtensionsMode>,
}

Fields

jsx_pragma: Cow<'static, str>

Replace the function used when compiling JSX expressions. This is so that we know that the import is not a type import, and should not be removed. defaults to React

jsx_pragma_frag: Cow<'static, str>

Replace the function used when compiling JSX fragment expressions. This is so that we know that the import is not a type import, and should not be removed. defaults to React.Fragment

only_remove_type_imports: bool

When set to true, the transform will only remove type-only imports (introduced in TypeScript 3.8). This should only be used if you are using TypeScript >= 3.8.

allow_namespaces: bool

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

optimize_const_enums: bool

Unused.

rewrite_import_extensions: Option<RewriteExtensionsMode>

Modifies extensions in import and export declarations.

This option, when used together with TypeScript’s allowImportingTsExtension option, allows to write complete relative specifiers in import declarations while using the same extension used by the source files.

When set to true, same as RewriteExtensionsMode::Rewrite. Defaults to false (do nothing).

Trait Implementations

impl Clone for TypeScriptOptions

fn clone(&self) -> TypeScriptOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TypeScriptOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TypeScriptOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TypeScriptOptions

where TypeScriptOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.