JS-0240 · Use shorthand property syntax for object literals

Use shorthand property syntax for object literals JS-0240

Anti-pattern

Minor

a month ago — a month old

Expected property shorthand

 87    const cart = carts.find((cart) => cart.id === getValues("cart"));
 88    if (addedProduct && cart) {
 89      toast.promise(
 90        dispatch(addProductToCart({ body: addedProduct, cart: cart })), 91        {
 92          loading: "Adding to cart...",
 93          success: "Added to cart",

Expected property shorthand

src/views/home/CheckoutTable.tsx

 71        );
 72      } else {
 73        toast.promise(
 74          dispatch(removeProductFromCart({ body: newItem, cart: cart })), 75          {
 76            loading: "Loading",
 77            success: "Success",

Expected property shorthand

src/views/home/CheckoutTable.tsx

 62    if (cart) {
 63      if (newItem.quantity > 0) {
 64        toast.promise(
 65          dispatch(updateProductFromCart({ body: newItem, cart: cart })), 66          {
 67            loading: "Loading",
 68            success: "Success",

Expected property shorthand

src/components/utils/Modal/Modal.tsx

14  return createPortal(
15    <>
16      <div className="container" style={{ width: "100%" }}>
17        <div className="modal" style={{ width: width }}>18          <header className="modal__title">
19            <p>{title}</p>
20            <Button backgroundColor="white" onClick={onClose}>

Description

ECMAScript 6 provides a concise form for defining object literal methods and properties. This syntax can make defining complex object literals much cleaner.

Here are a few common examples using the ES5 syntax:

const x = 1, y = 2, z = 3;
// properties
const foo = {
    x: x,
    y: y,
    z: z,
};

// methods
const foo = {
    a: function() {},
    b: function() {}
};

The ES6 equivalent syntax is::

// properties
const foo = {x, y, z};

// methods
const bar = {
    a() { return 1 },
    b() { return 2 }
};

NOTE: The shorthand properties are equivalent to function expressions. Meaning that they do not bind their own this inside their bodies. It is still possible to access properties from the object inside a shorthand member function:

const object = {
    x: 1,
    getX() {
        return this.x // valid
    }
}

Bad Practice

const foo = {
    bar: function () { return 1 }
};

Huthaifa-Dev / project

Bad Practice

Recommended