1.0.0 • Published 3 years ago

@mphbo/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

Lotide

A mini clone of the Lodash library.

Purpose

To replicate a small subset of the lodash library. These functions (all kept within an object) are handy for running quick operations on data without having to write functions yourself.

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • countLetters(sentence): takes in a sentence and returns a count of each of the letters in that sentence.
  • countOnly(allItems, itemsToCount): takes in a collection of items and return count for a specific subset of those items.
  • head(array): takes in an array and returns the first item.
  • tail(array): takes in an array and returns all the items except for the first one.
  • middle(array): takes in an array and returns the first item or two items depending on whether there is an even or odd number of items in the array.
  • findKey(object, callback): takes in an object and returns the keys of that object until the callback function returns false.
  • findKeyByValue(object, value): takes in an object, loops through the keys until the input 'value' is returned, otherwise the function returns undefined.
  • flatten(array): takes in an array, if there are any nested arrays they are broken down into one array level, essentially flattening the array.
  • map(array, function): replicates the functionality of map by taking in an array, applying the input 'function' to each item in the array, creating a new array with those values and returning the array.
  • pigLatin(string): takes in a string and translates it into the infamous pig latin language.
  • reverse(string): takes in a string and returns it in reverse.
  • takeUntil(array, callback): takes in an array, adds each item in the array from start to finish to a new array until the input 'callback' functions condition is met, at which point the array is returned.
  • without(array, itemsToRemove): takes in an array and removes all the items (itemsToRemove) from that array and returns the array.