1.0.0 • Published 3 years ago

@ayo-show/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 @ayo-show/lotide

Require it:

const _ = require('@ayo-show/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • head: A function which accepts an array as an argument, and returns the value at index 0.
  • tail: A function which accepts an array as an argument, and returns the values of everything but index 0.
  • middle: A function that accepts an array and returns the middle values of the array.
  • assertArraysEqual: A function that compares two arrays, will assert if two arrays are exactly the same.
  • assertEqual: A function which accepts two primitive data types as arguments: actual outcome and expected result. The function then prints to console whether the outcome matches the expected result with an assertion statement.
  • assertObjectsEqual: A function which takes two parameters, the actual object, and the expected object, and returns an assertion passed or failed.
  • countLetters: A function that will count the number of letters in a string, not including spaces.
  • countOnly: A function that accepts an array or objects and will count only the values that are specified.
  • eqArrays: A function that will determine whether two arrays are the same.
  • eqObjects: A function that determines whether two objects are equivalent.
  • findKey: A function that takes in an object and a callback, and returns the first key for which the callback returns a truthy value. If no key is found, then it returns undefined.
  • findKeyByValue: A functiion that will find a key using a value and an object.
  • letterPositions: A function that will find the index positions of a given letter within a string.
  • map : A function that will apply a given set of instructions to each element in an array.
  • takeUntil : A function that will collect items from a provided array until the callback function provided returns a truthy value.
  • without : A fuction that will return an array with the given values excluded from it.