1.0.0 • Published 3 years ago

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • head: functiont that takes and array and returns the first element
  • tail: function that takes an array and returns a new array containing every elements of the array except the first, without modifying the original array
  • middle: function that takes an array and returns the middle element/s
  • assertArraysEqual: function that takes two arrays and console.log an appropriate message to the console reflecting if the two arrays are equal
  • assertEqual: function to help test code
  • assertObjectsEqual: function that takes two objects and console.log an appropriate message to the console reflecting if the two objects are equal
  • countLetters: function that takes a sentence and returns a count of each of the letters in that sentence
  • countOnly: function that takes a collection of items and returns a count for a specific subset
  • eqArrays: function that takes in two arrays and returns true or false based on a perfect match
  • eqObjects: function that takes in two obejcts and returns true or false based on a perfect match
  • findKey: function that takes an object and a callback, and scans the object to return the first key for which the callback returns a truthy value
  • findKeyByValue: function that takes an object and a value, and scans the object to return the first key that contains the given value
  • flatten: function that takes an array containing elements, including nested arrays of elements, and returns a flattened version of the array
  • letterPositions: function that takes a string and returns all the indices in the string where each character is found
  • map: function that takes an array and a callback, and returns a new array based on the results of the callback function
  • takeUntil: function that takes an array and a callback, and returns a slice of the array with items taken from the beginning until a truthy value is found
  • without: function that takes an array and a remove list, and returns a subset of a given array removing unwanted elements