@bbashcode/lotide-flex/README.md

A clone of the lodash JavaScript library to practice creating various types of functions using JS.

# Lotide

A mini clone of the [Lodash](https://lodash.com) library.

## Purpose

**_BEWARE:_ This library was published for learning purposes. It is _not_ intended for use in production-grade software.**

This project was created and published by me as part of my learnings at Lighthouse Labs. 

## Usage

**Install it:**

`npm install @bbashcode/lotide-flex`


**Require it:**

`const _ = require('@bbashcode/lotide-flex');`

**Call it:**

`const results = _.tail([1, 2, 3]) // => [2, 3]`

## Documentation

The following functions are currently implemented:

* `countLetters`:  a method used to get the letter count in a given string
* `countOnly`: a function that takes in a collection of items and returns a specific subset of those items
* `eqArrays`: a function that takes in 2 arrays and returns true if the arrays are equal and false otherwise
* `eqObjects`: a function that takes in 2 objects and return true if they are equal and false otherwise
* `findKey`: a function that takes in an object and callback and returns the first key that meets the criteria specified in callback
* `findKeyByValue`: a function that takes in an object and a value and returns the first key that corresponds to that value
* `flatten`: a function that takes in an array that contains elements including nested array of elements and returns a flattened version of the array
* `head`: a function that takes in an array and returns the first element in the array
* `letterPositions`: a function that takes in a string and returns all indices of letter positions in the string
* `map`: a function that takes in an array and a callback and returns a new array based on the results of the callback on each item in the array
* `middle`: a function that takes in an array and returns middle most element of the array
* `tail`: a function that takes in an array and returns everything except the first element of the array
* `takeUntil`: a function that takes in an array and callback and returns a slice of the array based on the criteria specified in the callback
* `without`: a function that takes in a source array and an itemsToRemove arrays and returns only the items from the source array that are not in the itemsToRemove array


## Following functions have been implemented earlier for testing but have been replaced with chai and moca

* `assertArraysEqual`: a function that takes in 2 arrays and returns true if they are equal and false otherwiseion
* `assertEqual`: a function that takes in 2 values and returns true if they are equal and false otherwise
* `assertObjectsEqual`: a function that takes in 2 objects and returns true if they are equal and false otherwise

## Current test files are under test subdirectory