docs(transformer/nullish-coalescing): clarify doc comment (#7268)

Expand doc comment for `create_conditional_expression` to clarify what it does.
This commit is contained in:
overlookmotel 2024-11-14 16:17:21 +00:00
parent a48ebd6295
commit e219ae8c94

View file

@ -150,18 +150,25 @@ impl<'a, 'ctx> NullishCoalescingOperator<'a, 'ctx> {
}
}
/// Create a conditional expression
/// Create a conditional expression.
///
/// ```js
/// // Input
/// bar ?? "qux"
/// foo = bar ?? "qux"
///
/// // Output
/// qux = bar !== null && bar !== void 0 ? bar : "qux"
/// // ^^^ assignment ^^^ reference ^^^ default
/// foo = bar !== null && bar !== void 0 ? bar : "qux"
/// // ^^^ assignment ^^^ reference ^^^^^ default
/// ```
///
/// reference and assignment are the same in this case, but they can be different
/// ```js
/// // Input
/// foo = bar.x ?? "qux"
///
/// // Output
/// foo = (_bar$x = bar.x) !== null && _bar$x !== void 0 ? _bar$x : "qux"
/// // ^^^^^^^^^^^^^^^^ assignment ^^^^^^ reference ^^^^^ default
/// ```
fn create_conditional_expression(
reference: Expression<'a>,
assignment: Expression<'a>,