Use shorthand property syntax for object literals JS-0240
Anti-pattern
Minor
8 months ago
—
2 years old
Expected property shorthand
6import AccessPrivateProduct from "./AccessPrivateProduct";
7export default function SearchProducts({ name }: { name: string }) {
8 const { data, isLoading, error } = useGetProductsQuery({
9 name: name,10 page: 1,
11 });
12 const { products } = data ? (data as ProductResponse) : { products: [] };Expected property shorthand
19 const [{ isDragging }, drag] = useDrag(() => ({
20 type: 'post',
21 item: {
22 post: post,23 },
24 collect: (monitor) => ({
25 isDragging: !!monitor.isDragging(),Expected property shorthand
40 if (entries[0].isIntersecting && hasMore) {
41 await getComments({
42 postId: parseInt(postId as string),
43 lastId: lastId, 44 })
45 }
46 })Expected property shorthand
25 pathname: pathToPost,
26 query: {
27 name: data.product.name || (name as string),
28 channel: channel, 29 postId: data.ID,
30 },
31 })Expected property shorthand
47 useEffect(() => {
48 setPosts([])
49 getPosts({
50 productId: productId, 51 channel: (channel as string).toLowerCase(),
52 })
53 }, [channel])
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 }
};
Recommended
const foo = {
bar() { return 1 }
}