1.0.1 • Published 3 years ago
@irinagm/lotide v1.0.1
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 @irinagm/lotide
Require it:
const _ = require('@irinagm/lotide');
Call it:
const results = _.tail([1, 2, 3]) // => [2, 3]
Documentation
The following functions are currently implemented:
- assertArraysEqual(actual, expected): Function that recives two arrays as arguments and prints an appropriate message after comparing them.
- assertEqual(actual, expected): Function that takes in 2 values and returns 'Assertion Passed' if they are equal and 'Assertion Failed' otherwise.
- assertObjectsEqual(actual, expected): Function that takes in two Objects. Returns 'Assertion Passed' if both objects have identical keys with identical values. Otherwise returns 'Assertion Failed'.
- countLetters(string): Function that takes in a sentence and returns a count of each of the letters in the sentence.
- countOnly(allItems, itemsToCount): Function that takes in a collection of items and returns a specific subset of those items.
- eqArrays(array1, array2): Function that takes in 2 arrays and returns true if the arrays are equal and false otherwise.
- eqObjects(object1, object2): Function that takes in 2 objects and return true if they are equal and false otherwise.
- findKey(object, callback): Function that takes in an object and callback and returns the first key that meets the criteria specified in callback.
- findKeyByValue(object, value): Function that takes in an object and a value and returns the first key that corresponds to that value.
- flatten(array): Function that takes in an array that contains elements including nested array of elements and returns a flattened version of the array.
- head(array): Function that takes in an array and returns the first element in the array.
- letterPositions(string): Function that takes in a string and returns all indices of letter positions in the string.
- map(array, callback): Function that takes in an array and a callback and returns a new array based on the results of the callback on each item in the array.
- middle(array): Function that takes in an array and returns middle most element of the array.
- tail(array): Function that takes in an array and returns everything except the first element of the array.
- takeUntil(array, callback): Function that takes in an array and callback and returns a slice of the array based on the criteria specified in the callback.
- without(sourceArray, itemsToRemoveArray): Function that 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.