JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 48
  • Score
    100M100P100Q56492F
  • License MIT

An array manipulation toolbox.

Package Exports

  • array-kit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (array-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Array Kit

An array manipulation toolbox.

Early alpha.

Full BDD spec generated by Mocha:

TOC

.removeItems()

should produce a new array without any element matching the second array.

var input , copy ;

expect( arrayKit.removeItems( [ 1,2,3,4,5,4,3,2,1 ] , [ 2,4 ] ) ).to.eql( [ 1,3,5,3,1 ] ) ;
expect( arrayKit.removeItems( [ 1,2,3,4,5,4,3,2,1 ] , [ 2,4,6 ] ) ).to.eql( [ 1,3,5,3,1 ] ) ;
expect( arrayKit.removeItems( [ 1,2,3,4,5,4,3,2,1 ] , [] ) ).to.eql( [ 1,2,3,4,5,4,3,2,1 ] ) ;
expect( arrayKit.removeItems( [] , [ 2,4 ] ) ).to.eql( [] ) ;

var a = { a: 'a' } ;
var b = { b: 'b' } ;
var c = { c: 'c' } ;

// Check if the src/input array was left untouched
input = [ a , a , b , a ] ;
copy = input ;
expect( arrayKit.removeItems( input , [ a ] ) ).to.eql( [ b ] ) ;
expect( input ).to.eql( [ a , a , b , a ] ) ;
expect( input ).to.be( copy ) ;

expect( arrayKit.removeItems( [ a , a , a ] , [ a ] ) ).to.eql( [] ) ;
expect( arrayKit.removeItems( [ a , a , b , a ] , [ a ] ) ).to.eql( [ b ] ) ;
expect( arrayKit.removeItems( [ a , a , b , a ] , [ c ] ) ).to.eql( [ a , a , b , a ] ) ;
expect( arrayKit.removeItems( [ a , a , b , a ] , [ a , c ] ) ).to.eql( [ b ] ) ;

expect( arrayKit.removeItems( [ a , b , null , c ] , [ b ] ) ).to.eql( [ a , null , c ] ) ;
expect( arrayKit.removeItems( [ a , b , c ] , [ b , null ] ) ).to.eql( [ a , c ] ) ;
expect( arrayKit.removeItems( [ a , null , b , c ] , [ b , null ] ) ).to.eql( [ a , c ] ) ;

expect( arrayKit.removeItems( [ a , b , undefined , c ] , [ b ] ) ).to.eql( [ a , undefined , c ] ) ;
expect( arrayKit.removeItems( [ a , b , c ] , [ b , undefined ] ) ).to.eql( [ a , c ] ) ;
expect( arrayKit.removeItems( [ a , undefined , b , c ] , [ b , undefined ] ) ).to.eql( [ a , c ] ) ;

expect( arrayKit.removeItems( [ null , a , b , undefined , c ] , [ b ] ) ).to.eql( [ null , a , undefined , c ] ) ;
expect( arrayKit.removeItems( [ null , a , b , undefined , c ] , [ null , b ] ) ).to.eql( [ a , undefined , c ] ) ;
expect( arrayKit.removeItems( [ null , a , b , undefined , c ] , [ b , undefined ] ) ).to.eql( [ null , a , c ] ) ;
expect( arrayKit.removeItems( [ null , a , b , undefined , c ] , [ undefined , null , b ] ) ).to.eql( [ a , c ] ) ;

.delete()

should delete one index in-place.

var array

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 7 ) ;
expect( array ).to.eql( [ 1,2,3,4,5 ] ) ;
arrayKit.delete( array , 6 ) ;
expect( array ).to.eql( [ 1,2,3,4,5 ] ) ;
arrayKit.delete( array , 5 ) ;
expect( array ).to.eql( [ 1,2,3,4,5 ] ) ;

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 0 ) ;
expect( array ).to.eql( [ 2,3,4,5 ] ) ;

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 1 ) ;
expect( array ).to.eql( [ 1,3,4,5 ] ) ;

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 2 ) ;
expect( array ).to.eql( [ 1,2,4,5 ] ) ;

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 3 ) ;
expect( array ).to.eql( [ 1,2,3,5 ] ) ;

array = [ 1,2,3,4,5 ] ;
arrayKit.delete( array , 4 ) ;
expect( array ).to.eql( [ 1,2,3,4 ] ) ;