1.0.2 • Published 6 years ago

@writetome51/open-array-filter v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

The OpenArrayFilter class is a dependency of the OpenArray class ( package: @writetome51/open-array ).

To instantiate, pass the actual array it will contain into its constructor:

let filter = new OpenArrayFilter( item1, item2, item3,... );

You can also reset the array by accessing the classes 'data' property:

filter.data = 1,2,3,4,...;

OpenArrayFilter has methods that narrow down the content of the array it contains. These are all of them:

    // Narrows down the array to only the values that pass test:

	byTest(testFunction) // returns class instance
    // testFunction = function(currentValue, currentIndex, theArray){...}
    // testFunction must return boolean.


    // Narrows down the array to only values that are the specified type:

	byType(type: 'number' | 'boolean' | 'string' | 'array' | 'object' | 'function' | 'undefined')
    // returns class instance