1.0.0 • Published 4 years ago

@amanhundal/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
4 years ago

Lotide v1.0

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • head(array): function that takes in an array and returns the first element of that array.
  • assertArraysEqual(array1, array2): assertion test which takes in two arrays and checks to see if there are equal (===) or not.
  • assertEqual(actual, expected): simple check to see if two primative type values are equal (===) or not.
  • assertObjectsEqual(actual, expected): simple check to see if two objects are equal (===) or not.
  • countLetters(sentence): function that takes in a sentence and returns the count of each of the letters in the sentence.
  • findKey(object, callback): function that takes in an object and a callback function which takes in a check for truthiness. The function will return the first key in the object once the callback confirms true.
  • findKeyByValue(object,value): function that takes in an object and value (as a string) and returns the first key that has the passed in value.
  • letterPositions(sentence): function that takes in a sentence (as a string) and returns all index positions where the character is found (char applied as a key)
  • myMap(array, callback): simple recreation of the .map Array method.
  • middle(array: function that takes in an array and returns the middle value of the array (if array is odd) or the middle two values of the array (if the array is even).
  • tail(array): function that takes in an array and returns all elements (besides the first) back as an array.
  • takeUntil(array, callback): function that take in an array and callback predicate. the function will return an array of elements from the beginning until the callback predicate is true/met.
  • without(sourceArray, itemsToRemoveArray): function which takes in two arrays and returns a new array made up of elements from the first array excluding all elements in the second array.