1.0.2 • Published 5 years ago
@braverdan/lotide v1.0.2
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 @braverdan/lotide
Require it:
const _ = require('@username/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
function1(assertArraysEqual)
: Checks two arrays to ensure each item is equivilant. Even if the items are arrays themselves.function2(assertEqual)
: Gives out a true of false value for two inputs (expected and actual) to make sure they are equal. Does not work for objects.function3(assertObjectsEqual)
: Compares two objects and all their keys regardless of type to ensure they are equal. Also works on arrays.function4(countLetters)
: Counts the characters of a string and provides an object with the count of every character.function5(countOnly)
: Counts a given selection of items out of an array, outputs an object with each item and the count of said item.function6(eqArrays)
: Takes two arrays and ensures that they are equal, indluing nested arrays. assertArraysEqual is based on this function.function7(eqObjects)
: Takes two objects and check that they and their keys are equal. assertObjectsEqual is based on this function.function8(findKey)
: Find an object's first matching key based on the value.function9(findKeyByValue)
: Find an object's key given a value.function10(flatten)
: Takes a single layer nested array and flattens all items into a non nested array.function11(head)
: Outputs the first item of an array.function12(letterPositions)
: Given a string, produces an object with the index positions of each character.function13(map)
: Takes an array and allows for a callback function to act on each of the items.function14(middle)
: Finds the middle item or middle two items of a given array.function15(tail)
: Produces an array without the first element of the given array.function16(takeUntil)
: Produces an array of items up until a given input out of a given array.function17(without)
: Given an array to manipulate and a list of items to remove from said array, produces an array without the items given to remove.