b1fa6c9914b12f69efae3f5b2908c2e2021b8cc79a448a442a154d2c9c31a6d179ec7dba3f1864ad6f1df58a859a5882339d6ac9f40d749f2a2d89df00edc1 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. # safe-array-concat <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
  2. [![github actions][actions-image]][actions-url]
  3. [![coverage][codecov-image]][codecov-url]
  4. [![License][license-image]][license-url]
  5. [![Downloads][downloads-image]][downloads-url]
  6. [![npm badge][npm-badge-png]][package-url]
  7. `Array.prototype.concat`, but made safe by ignoring Symbol.isConcatSpreadable
  8. ## Getting started
  9. ```sh
  10. npm install --save safe-array-concat
  11. ```
  12. ## Usage/Examples
  13. ```js
  14. var safeConcat = require('safe-array-concat');
  15. var assert = require('assert');
  16. assert.deepEqual([].concat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'arrays spread as expected with normal concat');
  17. assert.deepEqual(safeConcat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'arrays spread as expected with safe concat');
  18. String.prototype[Symbol.isConcatSpreadable] = true;
  19. assert.deepEqual([].concat('foo', Object('bar')), ['foo', 'b', 'a', 'r'], 'spreadable String objects are spread with normal concat!!!');
  20. assert.deepEqual(safeConcat('foo', Object('bar')), ['foo', Object('bar')], 'spreadable String objects are not spread with safe concat');
  21. Array.prototype[Symbol.isConcatSpreadable] = false;
  22. assert.deepEqual([].concat([1, 2], 3, [[4]]), [[], [1, 2], 3, [[4]]], 'non-concat-spreadable arrays do not spread with normal concat!!!');
  23. assert.deepEqual(safeConcat([1, 2], 3, [[4]]), [1, 2, 3, [4]], 'non-concat-spreadable arrays still spread with safe concat');
  24. ```
  25. ## Tests
  26. Simply clone the repo, `npm install`, and run `npm test`
  27. [package-url]: https://npmjs.org/package/safe-array-concat
  28. [npm-version-svg]: https://versionbadg.es/ljharb/safe-array-concat.svg
  29. [deps-svg]: https://david-dm.org/ljharb/safe-array-concat.svg
  30. [deps-url]: https://david-dm.org/ljharb/safe-array-concat
  31. [dev-deps-svg]: https://david-dm.org/ljharb/safe-array-concat/dev-status.svg
  32. [dev-deps-url]: https://david-dm.org/ljharb/safe-array-concat#info=devDependencies
  33. [npm-badge-png]: https://nodei.co/npm/safe-array-concat.png?downloads=true&stars=true
  34. [license-image]: https://img.shields.io/npm/l/safe-array-concat.svg
  35. [license-url]: LICENSE
  36. [downloads-image]: https://img.shields.io/npm/dm/safe-array-concat.svg
  37. [downloads-url]: https://npm-stat.com/charts.html?package=safe-array-concat
  38. [codecov-image]: https://codecov.io/gh/ljharb/safe-array-concat/branch/main/graphs/badge.svg
  39. [codecov-url]: https://app.codecov.io/gh/ljharb/safe-array-concat/
  40. [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/safe-array-concat
  41. [actions-url]: https://github.com/ljharb/safe-array-concat/actions