1.0.0 • Published 3 years ago

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • `assert(): Used to test our code with Mocha & Chai
  • `assertArraysEqual(): Uses eqArrays to output an appropriate message
  • `assertEqual(): Test to check for bugs, if our code is running accordingly, if we are getting expected output
  • `assertObjectsEqual(): Return true if key and value in two given objects match else return false
  • `countLetters(): Return the count how many times a letter appears in a given string
  • `countOnly(): Return the count of given specific elements through a given array
  • `eqArrays(): Checks the primitive elements in two given arrays and returns true if they match
  • `eqObjects(): Checks the primitive key and values in two given objects and returns true if they match
  • `findKey(): Return the first key if the callback argument returns a truthy value else return undefined
  • `findKeyByValue(): Returns the key of an object that matches a given value
  • `flatten(): Returns a single array from a given multi-array (An array within arrays)
  • `head(): Returns the first element in a given array
  • `letterPositions(): Returns the indices of each character in given string
  • `map(): Returns an array containing the first letter of each word in given array
  • `middle(): Returns the middle elements for a given array either odd or even
  • `tail(): Returns a new array with all elements for given array without the head element 0
  • `takeUntil(): Return elements in an array upto but not including a element that matches a given conditon(s)
  • `without(): Filter through an array and filter out matching elements and return new array
1.0.0

3 years ago