1.0.0 • Published 5 years ago

@rjhand/lotide v1.0.0

Weekly downloads
1
License
ISC
Repository
github
Last release
5 years 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 @rjhand/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(arr1, arr2): Compares actual and expected arrays and returns passed or failed.
  • assertEqual(actual, expected): Compares expected and actual values.
  • assertObjectsEqual(actual, expected): Compares actual and expected objects and returns passed or failed.
  • countLetters(sentance): Counts the number of character occurances in a string.
  • countOnly(allItems, itemsToCount): Counts the number of times a string occurs in an array.
  • eqArrays(array1, array2): Compares two arrays and returns a boolean if the arrays are the same/different.
  • eqObjects(object1, object2): Compares two objects and returns a boolean if the object are the same/different.
  • findKey(object, callback): Takes an object and a callback. Scans the object and returns the first key for which the callback returns a truthy value.
  • findKeyByValue(object, value): Takes in an object and a value. It scans the object and returns the first key with the given value.
  • head(array): Returns the first element of an array.
  • letterPositions(sentance): Returns the index in which a letter occurs in a string within an array.
  • map(array, callback): Returns the first letter of each element in an array of strings.
  • middle(array): Returns the middle value (of odd) or values (if even) in an array longer than two elements.
  • tail(actual): Removes the first element in an array and returns the remaining elements in a new array.
  • takeUntil(array, callback): Takes an array and a callback function. Returns a new array of items occuring until the point specified by the callback functions.
  • without(source, itemsToRemove): Takes an array and items to remove. Returns a new array without the removed items.