array.prototype.tosorted ^{[![Version Badge][npm-version-svg]][package-url]}

[![dependency status][deps-svg]][deps-url]
[![dev dependency status][dev-deps-svg]][dev-deps-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

An ESnext spec-compliant Array.prototype.toSorted 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.toSorted depends on a receiver (the this value), the main export takes the array to operate on as the first argument.

Getting started

``sh
npm install --save array.prototype.tosorted
`

Usage/Examples

`js
var toSorted = require('array.prototype.tosorted');
var assert = require('assert');

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

var output = toSorted(input);

assert.deepEqual(output, [0, 1, 2, 3, 4, 5]);
assert.notEqual(output, input);
assert.deepEqual(input, [5, 4, 3, 2, 1, 0]);
`

`js
var toSorted = require('array.prototype.tosorted');
var assert = require('assert');
/ when Array#toSorted is not present /
delete Array.prototype.toSorted;
var shimmed = toSorted.shim();

assert.equal(shimmed, toSorted.getPolyfill());
assert.deepEqual(input.toSorted(), toSorted(input));
`

`js
var toSorted = require('array.prototype.tosorted');
var assert = require('assert');
/ when Array#toSorted is present /
var shimmed = toSorted.shim();

assert.equal(shimmed, Array.prototype.toSorted);
assert.deepEqual(input.toSorted(), toSorted(input));
`

Tests


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

[package-url]: https://npmjs.org/package/array.prototype.tosorted
[npm-version-svg]: https://versionbadg.es/es-shims/Array.prototype.toSorted.svg
[deps-svg]: https://david-dm.org/es-shims/Array.prototype.toSorted.svg
[deps-url]: https://david-dm.org/es-shims/Array.prototype.toSorted
[dev-deps-svg]: https://david-dm.org/es-shims/Array.prototype.toSorted/dev-status.svg
[dev-deps-url]: https://david-dm.org/es-shims/Array.prototype.toSorted#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/array.prototype.tosorted.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/array.prototype.tosorted.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/array.prototype.tosorted.svg
[downloads-url]: https://npm-stat.com/charts.html?package=array.prototype.tosorted