1.0.1 • Published 3 years ago

@lanuvelza/lotide v1.0.1

Weekly downloads
2
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 @lanuvelza/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertEqual(actual, expected): assesses whether if the actual value is the same as the expected value and console logs whether if the assertion is passed or failed.
  • assertArraysEqual(array1, array2): takes two arrays and console logs whether if both the arrays are the same or not.
  • assertObjectEqual(object1, object2): takes two objects and console logs whether if both objects are the same or not.
  • countLetters(string): takes a string and returns a count of each of the letters in that string as an object.
  • countOnly(array, object): takes an array and an object and returns an object containing the counts of everything the input object listed if the keys have truthy values only.
  • eqArrays(array1, array2): takes two arrays and returns a boolean evaluating if both arrays are the same.
  • eqObjects(object1, object2): takes two objects and returns a boolean evaluating if both objects are the same.
  • findKey(object, callback): takes an object and a callback function. Returns the first key for which the callback returns a truthy value. If no key is found, then undefined is returned.
  • findKeyByValue(object, keyValue) : takes an object and a key value. Returns the first key which contains the given key value. If no key with the given key value is found, return undefined.
  • flatten(array) : takes an array containing nested arrays and returns a flattened version of the array.
  • head(array) : takes an array and returns the first element.
  • letterPositions(string) : takes a string and returns an object containing all the indices of each character in the string.
  • map(array, callback) : takes an array and a callback function and returns a new array where each element is returned from the callback function.
  • middle(array) : takes an array and returns the middle-most elements of the array.
  • tail(array) : takes an array and returns everything but the first element of the array.
  • takeUntil(array, callback) : takes an array and a callback function. Returns an array of collected elements from the given array until the callback function provided is evaluated as a truthy value.
  • without(array1, array2) : takes an array and an array of unwanted elements. Returns a subset of a given array where the unwanted elements are removed.
1.0.1

3 years ago