1.0.0 • Published 3 years ago

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • head(...): returns the first item in the array.
  • tail(...): returns the "tail" of an array (everything except for the first item (head) of the provided array).
  • middle(...): take in an array and return the middle-most element(s) of the given array.
  • countLetters(...): take in a sentence (as a string) and then return a count of each of the letters in that sentence.
  • without(...): return a subset of a given array, removing unwanted elements.
  • flatten(...): take in an array containing elements including nested arrays of elements, and return a "flattened" version of the array.
  • letterPositions(...): return all the indices (zero-based positions) in the string where each character is found.
  • findKeyByValue(...): takes in an object and a value. It should 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.
  • eqObjects(...): take in two objects and returns true or false, based on a perfect match.
  • assertObjectsEqual(...): take in two objects and console.log an appropriate message to the console.
  • takeUntil(...): keep collecting items from a provided array until the callback provided returns a truthy value.
  • findKey(...): 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.
  • assertEqual(...): take in two values and assert whether or not they are equal.
  • eqArrays(...): takes in two arrays and returns true or false, based on a perfect match.
  • assertArraysEqual(...): asserts whether two arrays are equal.
  • map(...): return a new array based on the results of the callback function.
  • countOnly(...): return an object containing counts of everything that the input object listed.