1.0.0 • Published 2 years ago
@cor23/lotid 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 @cor23/lotide
Require it:
const _ = require('@cor23/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
assertArraysEqual(inputOne, inputTwo)
: for asserting that two arrays are equal.assertEqual(actual, expected)
: compare two values, prints out a message if they match or not.assertObjectsEqual(actual, expected)
: takes in two objects and compares them, prints out a message if they match or not.countLetters(string)
: counts the letters in a given string, returns an object w/ letter count.countOnly(allItems, itemsToCount)
: reports back how many instances of each string in itemsToCount were found in the allItems array of strings.eqArrays(inputOne, inputTwo)
: takes in two arrays and returns true or false, based on a perfect match.eqObjects(object1, object2)
: Returns true or false if both objects have identical keys with identical values.findKey(object, callback)
: takes in an object and a callback. returns the first key for which the callback returns a truthy value. If no key is found, then it returns undefined.findKeyByValue(object, value)
: takes in an object and a value, returns the first key which contains the given value, if no key with that given value is found, returns undefined.head(array)
: returns the first item in the array.letterPositions(sentence)
: returns all the indices (zero-based positions) in the string where each character is found.map(array, callBack)
: returns a new array based on the results of the callback function.middle(array)
: takes in an array and returns the middle-most element(s) of the given array.tail(array)
: returns the "tail" of an array. everything except for the first item of the provided array.takeUntil(array, callback)
: keeps collecting items from a provided array until the callback provided returns a truthy value.without(source, itemsToRemove)
: returns a new array with only those elements from source that are not present in the itemsToRemove array.
1.0.0
2 years ago