1.0.0 • Published 5 years ago

@aolvera/lotide v1.0.0

Weekly downloads
-
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 @aolvera/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • head(array): returns the first element of the input array.
  • tail(array): returns an array with all elements of the input array except the firt one.
  • middle(array): returns an array with the middle element(s) of the input array.
  • countLetters(string): returns a count of each letter in the string.
  • countOnly(array, object): returns counts for the items conatined in the input object that exist in the input array of strings.
  • eqArrays(array1, array2): returns true if both arrays match perfectly or false if they do not.
  • eqObjects(object1, object2): returns true if both objects match perfectly or false if they do not.
  • findKey(object, function): returns the first object key for which the callback function returns a truthy value.
  • findKeyByValue(object, value): returns the first object key for which that contains the given value.
  • flatten(array): returns a flattened version of an array where all the nested arrays are removed and their elements added to the first-level array.
  • letterPositions(string): returns an object containg lists of the indices in the string where each character is found.
  • map(array, function): returns a new array based on the results of the callback function.
  • takeUntil(array, function): returns a slice of the array starting from the begining, and ending when the callback function returns a truthy value.
  • without(array1, array2): returns a new array with only the elements from array1 that are not present in array2.