README

Permutation

Validates if a value is a permutation.

Installation

$ npm install validate.io-permutation

For use in the browser, use browserify.

Usage

var isPermutation = require( 'validate.io-permutation' );

isPermutation( arr, value )

Validates if a value is an array permutation. The first argument defines the list of values which can be permuted. The list array need not be unique and may contain repeated references to the same object.

var arr = [1,2,3],
    value = [2,3,1];

var bool = isPermutation( arr, value );
// returns true

Examples

var isPermutation = require( 'validate.io-permutation' );

console.log( isPermutation( [1,2,3], [2,3,1] ) );
// returns true

console.log( isPermutation( [1,2,3], [1,4,3] ) );
// returns false

console.log( isPermutation( ['a','c','b'], ['a','b'] ) );
// returns false

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

validate.io-permutation

Usage no npm install needed!