1.0.0 • Published 2 years ago

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

Require it:

const lotide = require('@mitchscho/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • head: Function returns the first element of an array
  • tail: Function removes the first item of an array and returns the tail
  • middle: Function returns the middle element of an array or the two middle elements of an even array
  • assertArraysEqual: Function compares array values and returns assertions
  • assertEqual: Function compares values to see if they are equal. Returns assertions
  • assertObjectsEqual: Function takes two objects and compares if they are equal. Returns assertions
  • countLetters: Function takes a sentence as a string returns a count of each letter in that sentence
  • countOnly: Function counts items of an array and compares them to an object variable
  • eqArrays: Function compares two arrays to check that they are equal
  • eqObjects: Function compares two object to check if they are equal
  • findKey: Function takes and object and a callback function. Loops through object and returns the first key that makes a truthy value with the callback
  • findKeyByValue: Function take and object and a value. It loops through the keys and return the first key that matches a given value
  • letterPositions:Function loops through a string and determines a letter position for a given letter.
  • map: Function takes an array and a callback function. Loops through the array conducting the callback functions operation until the loops finished
  • takeUntil: Function takes an array and a callback function. Function loops over the array until the callback functions condition is satisfied to true.
  • without:Function takes in a source array and an items to remove array. Compares the items to remove list to the array and returns an array with the items that were not on the to remove list.