1.0.1 • Published 1 year ago
@shamayal/lotide v1.0.1
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 @shamayal/lotide
Require it:
const _ = require('@shamayal/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
assertArraysEqual(firstArray, secondArray)
: an assert function that compares two arrays and logs a message to the console to tell us if they are a match or notassertEqual(firstArray, secondArray)
: an assert function that compares two values and logs a message to the console to tell us if they are a match or notassertObjectsEqual(object1, object2)
: an assert function that compares two objects and logs a message to the console to tell us if they are a match or notcountLetters(sentence)
: returns an objects with the count of each of the letters in a sentencecountOnly(allItems, itemsToCount)
: returns an object containing counts of everything from an array that the input object listedeqArrays(firstArray, secondArray)
: takes in two arrays and returns true or false, based on a perfect matcheqObjects(object1, object2)
: takes in two objects and returns true or false, based on a perfect matchfindKey(objectToScan, callback)
: returns the first key in an object for which the callback returns a truthy valuefindKeyByValue(objectToSearch, valueToFind)
: takes in an object and a value and returns the first key which contains the given valuehead(arrayElements)
: retrieves the first element of an arrayletterPositions(sentence)
: returns an object with all the indices of the letters in a stringmap(array, callback)
: returns a new array based on the result of the callback functionmiddle(arrayElements)
: returns an array with only the middle element(s) from the provided arraytail(arrayElements)
: retrieves every element except the first element of an arraytakeUntil(array, callback)
: returns a slice of the array with elements taken from the beginning until the callback returns a truthy valuewithout(sourceArray, itemsToRemove)
: removes specified items from an array and returns a new array without those itemsflatten(array)
: given an array with other arrays inside, it can flatten it into a single-level array