1.0.0 • Published 2 years ago

@prathap222/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 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 @prathap222/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(actual, expected): This function takes two arrays as its arguments, and will return a boolean whether two arrays are equal or unequal.
  • assertEqual(actual, expected): This function takes two values as its arguments, and will return a boolean whether two vales are equal or unequal.
  • assertObjectsEqual(actual, expected): This function takes two objects as its arguments, and will return a string specifying whether the two objects are equal or unequal.
  • countLetters(letters): This function take one string as argument, and will return the count of each character in a given string as an object.
  • countOnly(allItems, itemsToCount): This function takes two arguments, where first argument is an array, second argument is an object and returns count of the object from the given array
  • eqArrays(arrayA, arrayB): This function takes two arrays as its arguments, and will return a boolean whether two arrays are equal or unequal.
  • eqObjects(object1, object2): This function takes two object as its arguments, and will return a boolean whether two objects are equal or unequal.
  • findKey(object, callback): This function takes an object and a callback function as its arguments. The callback specifies the key you wish to find from the given object
  • findKeyByValue(obj,value): This funation takes an object and a value as its argumnets and returns the key of the given value.
  • head(arr): This function takes a arrays as its arguments, and returns the head of a given array (the value at index 0).
  • letterPositions(sentence): This function takes a string as its argument and returns the indexes of each character in a given string through the form of an object.
  • map(array, callback): This function takes a array and a callback function as its arguments,and returns a clone of the original array, with the values modified according to the specific condition in the callback function.
  • middle(array): This function takes a arrays as its arguments and returns the middle values of the given array.
  • tail(arr): Returns the tail of a given array (all of it's values except the one located at index 0).
  • takeUntil(array, callback): This function takes a array and a callback function as its arguments,and returns a new array, with all item included in the given array until a specified condition is met.
  • without(source, itemsToRemove): Returns a clone of the original array without the unwanted items specified. This function takes in a source array, and an array of items to remove from the source. This function will not modify the original array.