1.0.1 • Published 3 years ago

@saintcyn/lotide v1.0.1

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual: function that asserts if two arrays are equals
  • assertEqual: function that asserts if two values are equals
  • assertObjectsEqual: function that asserts if two objects are equals
  • countLetters: function that returns counts of each letter of a string
  • countOnly: function that takes items and returns counts for a specific subset of those items
  • eqArrays: function that compares two arrays
  • eqObjects: function that compares two objects
  • findKey: function that scans the object and return the first key for which the callback returns a truthy value
  • findKeyByValue: function that searches for a key on an object where its value matches a given value
  • flatten: function that flattens an array of arrays into a single-level array
  • head: function that retrieves the first element from the array
  • index: list of all the functions in an object
  • letterPositions: function that returns all the indices in the string where each character is found
  • map: function that creates a new array with the results of calling a provided function on every element in the calling array
  • middle: function that returns the middle element of an array
  • tail: function that retrieves every element except the head (first element) of the array
  • takeUntil: function that returns a slice of the array with elements taken from the beginning
  • without: function that removes elements from an array