@khnrv/lotide v1.1.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 @khnrv/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

assertArraysEqual(actualArray, expectedArray)

Function that takes in two arrays and print out if they match or not

assertEqual(actual, expected)

Compare two value and print out if they match or not

assertObjectsEqual(actual, expected)

This function compares two objects and print out if they match or not

countLetters(stringToCount)

This function takes in a sentence (as a string) and then return a count of each of the letters in that sentence.

countOnly(allItems, itemsToCount)

Function, given an array and an object, return an object containing counts of everything that the input object listed.

eqArrays(firstArray, secondArray) ⇒ boolean

Function that takes in two arrays and returns true or false, based on a perfect match.

Returns: boolean - Return whether the arrays are identical

eqObjects(object1, object2) ⇒ boolean

This function takes in two objects and returns true or false, based on a perfect match.

Returns: True if both objects have identical keys with identical values. Otherwise you get back a big fat false!

findKey(object, callback)

This function takes in an object and a callback. It scans the object and returns the first key for which the callback returns a truthy value. If no key is found, then it returns undefined.

findKeyByValue(objectToSearch, valueToFind)

This function scan a given object and return the first key which contains the given value. If no key with that given value is found, then it should return undefined.

flatten(arrayToFlatten)

This function will take in an array containing elements including nested arrays of elements, and return a "flattened" version of the array.

head(inputArray) ⇒ *

Output the value at index 0 of a given array

Returns: * - Value at index 0 of the input array

letterPositions(sentence)

This function returns all the indices (zero-based positions) in the string where each character is found.

map(arr, callback) ⇒ array

This function creates a new array populated with the results of calling a provided function on every element in the calling array.

middle(arrayToAnalyse) ⇒ array

This function takes in an array and return the middle-most element(s) of the given array.

Returns: array - - Middle element(s) of the given array

tail(inputArray) ⇒

For a given array, returns everything except for the first item (head).

Returns: - Returns a copy of the array without the first item (head)

takeUntil(array, callback)

This function keeps collecting items from a provided array until the callback provided returns a truthy value.

Kind: global function

without(arrayToEdit, itemsToRemove) ⇒ array

This function take in a source array and a itemsToRemove array. It return a new array with only those elements from source that are not present in the itemsToRemove array.

Returns: array - New array with only those elements from source that are not present in the itemsToRemove array