Symbol.isConcatSpreadable
En esta página
The Symbol.isConcatSpreadable static data property represents the well-known symbol Symbol.isConcatSpreadable. The {{jsxref("Array.prototype.concat()")}} method looks up this symbol on each object being concatenated to determine if it should be treated as an array-like object and flattened to its array elements.
{{InteractiveExample("JavaScript Demo: Symbol.isConcatSpreadable")}}
```js interactive-example const alpha = ["a", "b", "c"]; const numeric = [1, 2, 3]; let alphaNumeric = alpha.concat(numeric);
console.log(alphaNumeric); // Expected output: Array ["a", "b", "c", 1, 2, 3]
numeric[Symbol.isConcatSpreadable] = false; alphaNumeric = alpha.concat(numeric);
console.log(alphaNumeric); // Expected output: Array ["a", "b", "c", Array [1, 2, 3]]
## Value
The well-known symbol `Symbol.isConcatSpreadable`.
{{js_property_attributes(0, 0, 0)}}
## Description
The `[Symbol.isConcatSpreadable]` property can be defined as an own or inherited property and its value is a boolean. It can control behavior for arrays and array-like objects:
- For array objects, the default behavior is to spread (flatten) elements. `Symbol.isConcatSpreadable` can avoid flattening in these cases.
- For array-like objects, the default behavior is no spreading or flattening. `Symbol.isConcatSpreadable` can force flattening in these cases.
## Examples
### Arrays
By default, {{jsxref("Array.prototype.concat()")}} spreads (flattens) arrays into its result:
```js
const alpha = ["a", "b", "c"];
const numeric = [1, 2, 3];
const alphaNumeric = alpha.concat(numeric);
console.log(alphaNumeric); // Result: ['a', 'b', 'c', 1, 2, 3]
When setting Symbol.isConcatSpreadable to false, you can disable the default behavior:
const alpha = ["a", "b", "c"];
const numeric = [1, 2, 3];
numeric[Symbol.isConcatSpreadable] = false;
const alphaNumeric = alpha.concat(numeric);
console.log(alphaNumeric); // Result: ['a', 'b', 'c', [1, 2, 3] ]
Array-like objects#
For array-like objects, the default is to not spread. Symbol.isConcatSpreadable needs to be set to true in order to get a flattened array:
const x = [1, 2, 3];
const fakeArray = {
[Symbol.isConcatSpreadable]: true,
length: 2,
0: "hello",
1: "world",
};
x.concat(fakeArray); // [1, 2, 3, "hello", "world"]
[!NOTE] The
lengthproperty is used to control the number of object properties to be added. In the above example,length:2indicates two properties has to be added.
Specifications#
{{Specifications}}
Browser compatibility#
{{Compat}}
See also#
- Polyfill of
Symbol.isConcatSpreadableincore-js - {{jsxref("Array.prototype.concat()")}}