1.0.0 • Published 3 years ago
@jzlowie/lotide v1.0.0
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 @username/lotide
Require it:
const _ = require('@username/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
assertArraysEqual(arr1, arr2)
: Takes 2 arrays as arguments and prints a message unto the terminal/command prompt if both arrays at the same idices have the same elementsassertEqual(actual, expeted)
: Takes 2 arguments and compares the first argument to the second and prints the result onto the terminal/command promptassertObjectsEqual(actual, expected)
: Takes 2 objects as arguments and compares both objectscountLetters(str)
: Takes a string as an argument and counts how many times each letter appears in the string and is stored and returned as an objectcountOnly(allItems, itemsToCount)
: Takes 2 arguments, one is an array of names, the second argument is an object to determine which names to count. Returns an object that counts the number of times the name appeared in the arrayeqArrays(arg1, arg2)
: Takes 2 arrays as arguments and compares the arrays and returns a booleaneqObjects(object1, object2)
: Takes 2 objects as arguments and compares if both objects are the same and returns a booleanfindKey(obj, callback)
: Takes an object and a callback function as argument and implements callback function on the keys of the objectfindKeyByValue(obj, value)
: Takes an object and a value as arguments and returns the key that has the valueflatten(arr)
: Takes an array as an argument and takes all the nested arrays and returns one large arrayhead(arr)
: Takes an array as an argument and returns the first element of the arrayindex
: Object shorthandletterPositions(sentence)
: Takes a string as an argument and returns an object properties representing the indices of where each letter of the string appears as an arraymap(array, callback)
: Takes an array and a function as arguments and returns an array of the results of the function applied to each element of the arraymiddle(arr)
: Takes an array as an argument and returns the middle element(s)tail(arr)
: Takes an array as an argument and returns an array with the first element removedtakeUntil(array, callback)
: Takes an array and a callback function as arguments and returns a sub array when the function applied to the elements of the array returns truewithout(source, itemsToRemove)
: Takes 2 arrays as arguments and returns an array with the selected elements removed
1.0.0
3 years ago