Lotide

A mini clone of the Lodash 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 @carolineolagunju/lotide

Require it:

const _ = require('@carolineolagunju/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

• countLetters(letters): The function takes in a string sentence and returns an object containing the counts of how many times a letter appears in the sentence.

• countOnly(allItems, itemToCount): The function takes in an array(allItems) and an object(itemsToCount). The function checks if the element in array(allItems) is present in the object(itemsToCount) as a key and will only count the key if its value is truthy. The counted keys are returned as an object. It will not count a key that is not present in the array even if the key has a truthy value.

• eqArrays(arr1, arr2): it takes in 2 arrays as its parameters and returns true if the element type, index and length are equal but returns false if otherwise.

• eqObjects(object1, objects2): It takes in two objects and returns true if the objects have the same keys and values but returns false if otherwise.

• findKey(objs, callback): Function findKey takes in an object and a callback. It iterate through the object and returns the key that meets the condition set by the callback. If it does not find the key, it returns undefined.

• findKeyByValue(objs, value): The function takes in an object and a value, it goes through the object and returns the key that contains the given value. It returns undefined if there is no key containing the given value.

• flatten(): Flatten takes in array of elements, including nested array and returns a flat copy of the array.

• head(arr): This function returns the first element of the array that is being passed in.

• letterPositions(sentence): The function takes in a string sentence as its parameter, returns an object. The letters of the sentence will be the keys of the returned object, the value of the key is an array, the array will house index(position) of each letter in the sentence. If a letter appears more than one time, the index number will be pushed into the array as another element.

• map(array, callback): The function takes in an array of strings and a callback function. The callback function takes in the given array as its parameter. The map function loops through each element of the array and the callback function returns whatever is in the first index of each element that is beign iterated. All the elements gets pushed into an array and the function finally returns that arry. For example if it takes in ["carol", "papa", "jesus"] it returns ["c", "p", "j"].

• middle(arr): It returns an array of the middle element of a given array. If the given array length is less than 3, it returns an emprty array [], if the given array length is 6, for example [1,2,3,4,5,6] it returns [3,4], if the given array length is 3, for example [1,2,3] it returns [2].

• tail(arr): The function takes away the first element of the array that is passed into it and returns an array of the rest of the elements.

• takeUntil(array, callback): The function takes in array of elements and a callback function. It loops through the element of the array and it keeps looping until it meets the condition specified by the call back. For example if it takes in [1,2,3,4] and if the callback was to return when element is === 3. The function will return [1,2] and slice the rest of the element.

• without(arrA, arrB): The function takes in two arrays. The first array is the source array while the second array includes the items to be removed. If the element of arrB cannot be found in arrA, the function returns that element. i.e the function only returns the elements that can be found in arrB but cannot be found in arrA.