1.0.0 • Published 5 years ago

@caronise/lotide v1.0.0

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(): Function that accepts two arrays as parameters and prints an appropriate message to the console telling us if they match or not.
  • assertEqual(): Function that compares the two values passed to it and prints a message indicating whether they match or not.
  • assertObjectsEqual(): Function that accepts two objects as parameters and prints a message to the console telling us if they match or not.
  • countLetters(): Function that returns an object where each property is a unique character whose value is the number of times that character occurred.
  • countOnly(): Function that takes in a collection of items and returns the count for a specific item.
  • eqArrays(): Function that takes in two arrays and returns true or false, based on a perfect match.
  • eqObjects(): Function that takes in two objects and returns true or false, based on a perfect match.
  • findKey(): Function takes in an object and a callback function. It will iterate through the object and return the first key for which the callback returns a truthy value. If no key mathces, then it'll return undefined.
  • findKeyByValue(): Function that takes in an object and a value. It should scan the object and return the first key which contains the given value. If no key with that given value is found, then it should return undefined.
  • flatten(): Function that accepts an array of arrays as a parameter and returns a flattened (single) array.
  • head(): Function that returns the first item in an array.
  • letterPositions(): Function that returns the indices of the string where the respective character is found.
  • map(): Function that returns a new array based on the results of the callback function.
  • middle(): Function that takes in an array and returns the middle-most element of an odd numbered array or the two middle-most elements of an even array.
  • tail(): Function that returns the array without the first element.
  • takeUntil(): Function that returns a selected amount of elements taken from the beginning, until the callback returns a truthy value.
  • without(): Function that returns a new array, removing the unwanted elements from the given array.