Use shorthand property syntax for object literals JS-0240
Anti-pattern
Minor
a month ago
—
2 months old
Expected property shorthand
72 pendingTransactionsUrl: "",
73 },
74 networkName: networkNameRopsten,
75 networkType: networkType, 76 chainId: "3",
77 }
78 })Expected property shorthand
54 pendingTransactionsUrl: "",
55 },
56 networkName: networkNameDevnet,
57 networkType: networkType, 58 chainId: "...",
59 }
60 providerConfigRopsten = {Expected property shorthand
36 pendingTransactionsUrl: "",
37 },
38 networkName: networkNameMainnet,
39 networkType: networkType, 40 chainId: "...",
41 }
42 providerConfigDevnet = {Expected property shorthand
57 beforeAll(async () => {
58 networkType = "testnet"
59 agentArgs = {
60 getPassphrase: getPassphrase, 61 mnemonicWords: PREGENERATED_MNEMONIC,
62 }
63 network = DEFAULT_NETWORKExpected property shorthand
214 `Network Configuration is not defined for the chainId: ${chainId}`,
215 )
216 }
217 return { chainId: chainId, networkName: networkConfig?.networkName }218 }
219 throw new Error("Something went wrong!")
220 }
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 }
}