1.0.6 • Published 2 years ago
@lynwang/lotide v1.0.6
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 @lynwang/lotide
Require it:
const _ = require('@lynwang/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
head(array)
: takes in an array and returns the first element in the arraytail(array)
: takes in an array and returns everything except the first element of the arraymiddle(array)
: takes in an array and returns middle most element of the arrayassertArraysEqual(arrayOne, arrayTwo)
: takes in 2 arrays and returns true if they are equal and false otherwiseassertEqual(actual, expected)
: takes in 2 values and returns true if they are equal and false otherwiseassertObjectsEqual(objOne, objTwo)
: takes in 2 objects and returns true if they are equal and false otherwisecountLetters(word)
: takes in a sentence and returns a count of each of the letters in the sentencecountOnly(allItems, itemsToCount)
: takes in a collection of items and returns a specific subset of those itemseqArrays(firstArray, secondArray)
: takes in 2 arrays and returns true if the arrays are equal and false otherwiseeqObjects(object1, object2)
: takes in 2 objects and return true if they are equal and false otherwisefindKey(obj, callback)
: takes in an object and callback and returns the first key that meets the criteria specified in callback.findKeyByValue(keyFind, valu)
: takes in an object and a value and returns the first key that corresponds to that valueflatten(list)
: takes in an array that contains elements including nested array of elements and returns a flattened version of the array.letterPositions(sentence)
: takes in a string and returns all indices of letter positions in the stringmap(array, callback)
: takes in an array and a callback and returns a new array based on the results of the callback on each item in the arraytakeUntil(array, callback)
: takes in an array and callback and returns a slice of the array based on the criteria specified in the callbackwithout(source, itemsToRemove)
: takes in a source array and an itemsToRemove arrays and returns only the items from the source array that are not in the itemsToRemove array