lòd
Change the order of an array
Getting Started
From browsers and node.
Install the module with: npm install lod
.
NOTE: lòd use the ES6 module definition. For now, it uses Babel to transpile to ES5.
So, if you use ES5, you should require lòd withvar lod = require( "lod" ).default;
, and, if you use ES6, you should import lòd withimport lod from "lod";
.
Documentation
lòd returns a new, reordered version of an array, using another array of ordered indexes.
Signature
reordered_array = lod( source_array, order_array[, strict_mode ] );
Example
var lod = default; var source_array = "one" "two" "three" "four" ; var reordered_array = ; // [ "three", "four", "one", "two" ]
See tests for other examples.
Strict mode
When the strict_mode
arguments is set to true, source_array
and order_array
must have the same length and the order_array
can't have duplicate values.
Restrictions & errors
-
lòd will throw a
Error( "INVALID_ORDER_CONTENT" )
if theorder_array
contains elements that are not Number. -
lòd will throw a
Error( "OUT_OF_BOUNDS_ORDER_INDEX" )
if theorder_array
contains numbers that are not inside thesource_array
range. -
lòd will throw a
Error( "NOT_EQUAL_LENGTH" )
if theorder_array
andsource_array
doesn't have equal length (strict_mode only). -
lòd will throw a
Error( "INVALID_DUPLICATE_IN_ORDERS" )
if theorder_array
contains duplicate values (strict_mode only).
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
- 0.1.0: Initial release (20/01/16)
License
(Un)licensed under the UNLICENSE