chore: add some doc for napi TsconfigOptions (#20)

chore: 🤖 add some field doc for TsconfigOptions
oxc-project · Dec 12, 2023 · 2d5d678 · 2d5d678
1 parent 276390d
commit 2d5d678
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/napi/src/options.rs b/napi/src/options.rs
@@ -182,8 +182,8 @@ pub struct TsconfigOptions {
     /// * an absolute path to the configuration file.
     pub config_file: String,
     /// Support for Typescript Project References.
-    /// For the type TsconfigReferences
-    ///
+    /// alias type for [oxc_resolver::TsconfigReferences], cause napi does't support structured
+    /// enum
     #[napi(ts_type = "'disabled'| 'auto' | 'Array<string>'")]
     pub references: Either<String, Vec<String>>,
 }