1.0.0 • Published 1 year ago

@adam-marx/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

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 @adam-marx/lotide

Require it:

const _ = require('@adam-marx/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • head(array): Returns the first element of an array.
  • tail(array): Returns everything but the first element of an array.
  • middle(array): Returns the middle value of an array, if the array is odd it returns the median of the middle two elements.
  • assertArraysEqual(array1, array2): Asserts if two arrays are equal to each other and returns a console.log that tells you if the assertation passed or failed.
  • assertEqual(actual, expected): Asserts if two values; actual and expected, are equal to each other.
  • assertObjectsEqual(actual, expected): Asserts if two objects are equal to each other and logs a pass or fail message.
  • countLetters(sentence): Returns the amount of times a letter appears in a string, case sensitive.
  • countOnly(allItems, itemsToCount): Counts only the specified items of an array
  • eqArrays(array1, array2): Checks if two arrays are equal to one another.
  • eqObjects(object1, object2): Checks if two obejcts are equal to one another.
  • findKeyByValue(object, value): Finds the key of an object given the key value.
  • findKey(object, callback): Finds the key of an object given a callback function that provides the key value.
  • letterPositions(sentence): Returns all the positions by index-value of characters in a string.
  • map: Higher order function that takes a callback and executes that function on items of an array.
  • takeUntil(array, callback): Takes items in an array until the string hits the specified character to stop taking items.
  • without(source, itemsToRemove): Returns an array provided without the array values specified by the user.