@pagr/lotide v1.0.0

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

• assertArraysEqual: This function uses the eqArrays function to check if two elements are equal, then prints a result to the console.
• assertEqual: ascertains if two primitive values are equal.
• assertObjectsEqual: the assertObjectsEqual funciton takes in two objects and uses the eqObjects function above to see if they are the same. This function then outputs an approriate message to the console.
• countLetters: countLetters function that takes a string as an input and returns an object that identifies the number of times each letter in the string appears.
• countOnly: this function returns the number of times a specific element is present in an array
• eqArrays: checks to see if two arrays are identical by iterating through the array elements
• eqObjects: Returns true if both objects have identical keys with identical values.
• findKey: findKey takes in an object and a callback. It scans the object and returns the first key for which the callback returns a truthy value. Returns undefined if no key is found.
• findKeyByValue: returns the key in an object that matches a specific value
• head: This function returns the first value in an array
• letterPositions: accepts a string and returns a report (object) that lists every character in the string (skipping spaces but including numbers and special characters) paired with an array indicating the index of each appearance of that letter in the string.
• map: This funtion takes in two arguments: an array to be mapped and a callback function to describe how the array will be mapped. This function will then return a new array based on the effect of the callback function on the initial array
• middle: This function will return the middle value of an array (as an array), or if there are an even number of elements in the input array, it will return the two elements in the middle of the input array. Returns an empty array for input arrays of 1 or 2 elements.
• tail: This returns an array with the first element (i.e. the "head") removed. This is the "rest" of the array.
• takeUntil: this function takes an input array and a callback function. It basically takes a slice off the front of the array, returning each value until the callback function returns a truthy value.
• without: This function will return a subset of the source array, with all of the elements listed in the itemsToRemove array removed