1.0.0 • Published 3 years ago

lotidenick 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 @nicholasjj/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual: Takes in two arrays as arguments and compares them. The assertion will be printed to the terminal.
  • assertEquals: Takes in two valules as arguments and compares them. The assertion will be printed to the temrinal.
  • assertObjectEqual: Takes in an object as arguments and compares them. The assertion will be printed to the terminal.
  • countLetters: Takes in a strng as an arugment and returns back an object with the count of each letter in the string.
  • countOnly: Takes in an array as a arugment and an object containing the elements to be counted. Returns back the count of each element requested.
  • eqArrays: Takes in two arrays as arugments and checks to see if the arrays are equal.
  • eqObjects: Takes in two object as arugments and checks to see if the objects are equal.
  • findKey: Takes an object & a callback function as arugments. If a truey value is found it will return the key of the keypair value.
  • findKeyByValue: Takes in objects as a a value as arugments. Returns back the key if a value is matching.
  • head: Takes in an array and returns back in the first element of the array.
  • index: Contains the module.exports for all functions within the package.
  • map: Takes in an array and callback function. If an element in the array is matching the callback function it will placed into a new array. Returns an array with all the elements matching the callback function.
  • middle: Takes in an array as an arugment and retuns back the middle values(s) of he the array.
  • tail: Takes in an array as an arugment and removes the first element of the array and returns the rest.
  • takeUntil: Takes in an array and a callback function as arugments. The function will iterate through the array until there is a value matching the callback function. The elements not matching the callback function till the point will be returned.
  • without: Takes in an array and a callback function. The function will iterate over the array and will push any elements not matching the calback function into a new array and return the array.