array.prototype.with

array.prototype.with

An ESnext spec-compliant Array.prototype.with shim/polyfill/replacement that works as far down as ES3.

This package implements the es-shim API interface. It works in an ES3-supported environment and complies with the proposed spec.

Because Array.prototype.with depends on a receiver (the this value), the main export takes the array to operate on as the first argument.

Getting started

npm install --save array.prototype.with

Usage/Examples

var arrayWith = require('array.prototype.with');
var assert = require('assert');

var arr = [0, 1, 2, 3, 4, 5];

var results = arrayWith(arr, 3, 'c');

assert.deepEqual(results, [0, 1, 2, 'c', 4, 5]);
assert.deepEqual(arr, [0, 1, 2, 3, 4, 5]);

var arrayWith = require('array.prototype.with');
var assert = require('assert');
/* when Array#with is not present */
delete Array.prototype.with;
var shimmed = arrayWith.shim();

assert.equal(shimmed, arrayWith.getPolyfill());
assert.deepEqual(arr.with(0, true), arrayWith(arr, 0, true));

var arrayWith = require('array.prototype.with');
var assert = require('assert');
/* when Array#with is present */
var shimmed = arrayWith.shim();

assert.equal(shimmed, Array.prototype.with);
assert.deepEqual(arr.with(1, false), arrayWith(arr, 1, false));

Tests

Simply clone the repo, npm install, and run npm test