Skip to content

Latest commit

 

History

History
63 lines (31 loc) · 2.64 KB

README.md

File metadata and controls

63 lines (31 loc) · 2.64 KB

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 @syldrew/lotide

Require it:

const _ = require('@syldrew/lotide');

Call it:

const results = _.tail([1, 2, 3]) // => [2, 3]

Documentation

The following functions are currently implemented:

assertArraysEqual(actual, expected) : a function that prints an appropriate message after comparing the two arrays.

assertEqual(actual, expected):an updated Assert Equal Function that uses template literals.

assertObjectsEqual(actual, expected): a function that takes in 2 objects and returns true if they are equal and false otherwise.

countLetters(stringInp): a function that takes in a sentence and returns a count of each of the letters in the sentence.

countOnly(allItems, itemsToCount): a function that takes in a collection of items and returns a specific subset of those items.

eqArrays(arr1, arr2): a function that takes in 2 arrays and returns true if the arrays are equal and false otherwise.

eqObjects(object1, object2): a function that takes in 2 objects and return true if they are equal and false otherwise.

findKey(object, callback): a function that takes in an object and callback and returns the first key that meets the criteria specified in callback.

findKeyByValue(obj, val): a function that takes in an object and a value and returns the first key that corresponds to that value.

flatten(arr): a function that takes in an array of nested arrays, return new array containing all elements contained in nested arrays

head(array):a function that takes in an array and returns the first element in the array.

letterPositions(sentence): a function that takes in a string and returns all indices of letter positions in the string.

map(array, callback): a 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(firstArray):a function that takes in an array and returns middle most element of the array.

tail(arr): a function that takes in an array, removes arr[0] and returns the rest.

takeUntil(array, callback): a function that takes in an array and callback and returns a slice of the array based on the criteria specified in the callback.

without(sourceArr, itemsToRemove):a 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.