1.0.4 • Published 2 years ago
@lmtpox/lotide v1.0.4
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 @lmtpox/lotide
Require it:
const _ = require('@lmtpox/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
For examples of all implemented functions:
npm run test
The following functions are currently implemented:
assertArraysEqual(actual, expected): Compares two arrays, gives assertion if equal.assertEqual(actual, expected): Compares two values, gives an assertion if equal.assertObjectsEqual(actual, expected): Compares two objects, gives an assertion if equal.countLetters(string): Counts the amount of letters in a given string.countOnly(allItems, itemsToCount): Takes an array of strings, and an object specifying what to count. Returns the number of occurences.eqArrays(arr1, arr2): Takes in two arrays and returns a boolean depending on if they are equal.eqObjects(object1, object2): Takes in two objects and returns a boolean depending on if they are equal.findKey(obj, callback): Takes in an object and a callback that checks for something within said object, and returns the key if found.findKeyByValue(obj, content): Takes in an object and the content of a key, then returns the key that contains said content.flatten(array): Takes in an array containing an array and flattens them to a single-level array.head(array): Takes in an array and returns the first element in it.letterPositions(string): Takes in a string and returns an object that lists the letters and their positions.map(array, callback): Takes in an array and a callback then returns an array based on the callback's specification.middle(array): Takes in an array and returns the middle element(s).tail(array): Takes in an array and returns the last element in it.takeUntil(array, callback): Takes in an array and callback that specifies a point to cut off. Returns an array that includes elements up until the element specified by the callback.without(array, toRemove): Takes in array and an array of elements to be removed from the first array. Returns a new array with the remaining values.