1.0.0 • Published 3 years ago

@francois.martineau/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 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 @francois.martineau/lotide

Require it:

const _ = require('@francois.martineau/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • head(array) : returns the first item in the array.
  • tail(array) : returns the "tail" of an array: everything except for the first item (head) of the provided array.
  • middle(array) : take in an array and return the middle-most element(s) of the given array.
  • eqArrays(array1, array2) : takes in two arrays and returns true or false, based on a perfect match.
  • assertArraysEqual(array1, array2) : take in two arrays and console.log an appropriate message to the console.
  • assertEqual(actual, expected) : take in two values and console.log an appropriate message to the console.
  • assertObjectsEqual(actual, expected) : take in two objects and console.log an appropriate message to the console.
  • countLetters(sentence) : take in a sentence (as a string) and then return a count of each of the letters in that sentence.
  • countOnly(allItems, itemsToCount) : take in a collection of items and return counts for a specific subset of those items. It won't count everything, just the itemsToCount, ignoring the others. (Items must be Strings).
  • eqObjects(object1, object2) : take in two objects and returns true or false, based on a perfect match.
  • findKey(object, CB) : takes in an object and a callback. It should scan the object and return the first key for which the callback returns a truthy value. If no key is found, then it should return undefined.
  • findKeyByValue(object, value) : scan the 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.
  • letterPositions(sentence) : return all the indices (zero-based positions) in the string where each character is found.
  • map(array, callback) : return a new array based on the results of the callback function.
  • takeUntil(array, callback) : it keep collecting items from a provided array until the callback provided returns a truthy value.
  • without(source, itemsToRemove) : take out an items from an array.