1.0.0 • Published 2 years ago

@habizat/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 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 @habizat/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(array1, array2): asserts that two arrays are equal
  • assertEqual(actual, expected): compares the two values and prints out a message telling if they match or not
  • assertObjectsEqual(object1, object2): helps test functions that return objects
  • countLetters(sentence): returns a count of each of the letters in that sentence
  • countOnly(allItems, itemsToCount): takes in a collection of items and returns counts for a specific subset of those items
  • eqArrays(array1, array2): returns true or false, based on a perfect match of given arrays
  • eqObjects(object1, object2): returns true or false, based on a perfect match. Objects's values are limited to primitive values and arrays.
  • findKey(object, callback): returns the first key for which the callback returns a truthy value
  • findKeyByValue(object, value): returns the first key which contains the given value
  • head(array): returns first element in an array
  • letterPositions(sentence): returns all the indices in the string where each character is found
  • map(array, callback): returns a new array based on the results of the callback function
  • middle = function(array): returns the middle-most element(s) of the given array
  • tail(array): returns 'tail' of an array
  • takeUntil(array, callback): keeps collecting items from a provided array until thecallback provided returns a truthy value
  • without(source, itemsToRemove): returns a subset of a given array, removing unwanted elements