| # safe-array-concat <sup>[![Version Badge][npm-version-svg]][package-url]</sup> |
| |
| [![github actions][actions-image]][actions-url] |
| [![coverage][codecov-image]][codecov-url] |
| [![License][license-image]][license-url] |
| [![Downloads][downloads-image]][downloads-url] |
| |
| [![npm badge][npm-badge-png]][package-url] |
| |
| `Array.prototype.concat`, but made safe by ignoring Symbol.isConcatSpreadable |
| |
| ## Getting started |
| |
| ```sh |
| npm install --save safe-array-concat |
| ``` |
| |
| ## Usage/Examples |
| |
| ```js |
| var safeConcat = require('safe-array-concat'); |
| var assert = require('assert'); |
| |
| assert.deepEqual([].concat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'arrays spread as expected with normal concat'); |
| assert.deepEqual(safeConcat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'arrays spread as expected with safe concat'); |
| |
| String.prototype[Symbol.isConcatSpreadable] = true; |
| assert.deepEqual([].concat('foo', Object('bar')), ['foo', 'b', 'a', 'r'], 'spreadable String objects are spread with normal concat!!!'); |
| assert.deepEqual(safeConcat('foo', Object('bar')), ['foo', Object('bar')], 'spreadable String objects are not spread with safe concat'); |
| |
| Array.prototype[Symbol.isConcatSpreadable] = false; |
| assert.deepEqual([].concat([1, 2], 3, [[4]]), [[], [1, 2], 3, [[4]]], 'non-concat-spreadable arrays do not spread with normal concat!!!'); |
| assert.deepEqual(safeConcat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'non-concat-spreadable arrays still spread with safe concat'); |
| ``` |
| |
| ## Tests |
| Simply clone the repo, `npm install`, and run `npm test` |
| |
| [package-url]: https://npmjs.org/package/safe-array-concat |
| [npm-version-svg]: https://versionbadg.es/ljharb/safe-array-concat.svg |
| [deps-svg]: https://david-dm.org/ljharb/safe-array-concat.svg |
| [deps-url]: https://david-dm.org/ljharb/safe-array-concat |
| [dev-deps-svg]: https://david-dm.org/ljharb/safe-array-concat/dev-status.svg |
| [dev-deps-url]: https://david-dm.org/ljharb/safe-array-concat#info=devDependencies |
| [npm-badge-png]: https://nodei.co/npm/safe-array-concat.png?downloads=true&stars=true |
| [license-image]: https://img.shields.io/npm/l/safe-array-concat.svg |
| [license-url]: LICENSE |
| [downloads-image]: https://img.shields.io/npm/dm/safe-array-concat.svg |
| [downloads-url]: https://npm-stat.com/charts.html?package=safe-array-concat |
| [codecov-image]: https://codecov.io/gh/ljharb/safe-array-concat/branch/main/graphs/badge.svg |
| [codecov-url]: https://app.codecov.io/gh/ljharb/safe-array-concat/ |
| [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/safe-array-concat |
| [actions-url]: https://github.com/ljharb/safe-array-concat/actions |