1.0.0 • Published 6 years ago
@johnarvi/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 @johnarvi/lotide
Require it:
const _ = require('@johnarvi/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
assertArraysEqual(arr1, arr2): Logs a message to show whether 2 arrays match.assertEqual(x,y): Logs a message to show whether 2 primary objects match.assertObjectsEqual(Obj1, Obj2): Logs a message to show whether 2 objects match.countLetters(string): returns the count of each letter of the string with an Object format.countOnly(allItems, itemsToCount): returns the number of times a value (itemsToCount) appears in an arrayeqObject(object1, object2): compares tow objects and returns a bollean if the values are the same and the number of keys are the same. This currently does not work on nested objects- to be implented at a later dateeqArrays(arr1,arr2): compare 2 arrays and return true if they’re equal. This currently does not work on nested arrays- to be implented at a later datefindKey(obj1, callback): returns the first key which matches the value which is given by the callback.findKeyByValue(object, value): returns the first key which matches the value. (This is with no callback function).flatten(array): Takes in a potentially nested array and spreads it to a single-nested array.head(array): returns the front of the array.letterPositions(sentence): returns an object that contains the letters (key) and index positions (value) of the sentencemap(array, callback): takes in two arguments 1) array to map and 2) callback function (when predicate is met) should return the altered arraymiddle(array): returns a new array with the middle index value/s of the original arraytail(array): returns a new array without the first index value of the original arraytakeUntil(array, callback): takes a slice of an array with index values taken from the beginning until callback/predicate returns a truthy valuewithout(source, itemsToRemove): returns an array without the specified items
1.0.0
6 years ago