1.0.0 • Published 6 months ago

@yusuf.m/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months 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 @yusuf.m/lotide

Require it:

const _ = require('@yusuf.m/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(arr1, arr2): logs to the console weather two arrays are equal or not.

  • assertEqual(actual, expected): logs to the console weather acutal and expected are equal if they are it will log pass if not it will log fail

  • assertObjectsEqual(actual, expected): it uses eqObjects to check if actual and expected are equal and then logs them

  • countLetters(sentence): the countLetter function takes sentence as input and returns a object that respresents the count of each letter in the sentence.

*countOnly(allItems, itemsToCount): the count only function iterates through each item in allItems checks if it should be counted based on itemsToCount and updates the count in the results object accordingly. after it returns the results object containting the counts of speicfic items

*eqArrays(arr1, arr2): the function compares the length of the arrays then if they are equal it checks each corresponding pair of elements. if the pairs aren't equal it returns false. if it is equal it returns true.

*eqObjects(object1, object2): this function compares the keys of the two objects and then iterates through each key, checking if the vaules are equal if they are it logs true. if any pair of keys and vaules is not equal the function logs false.

*findKey(object, callback): searches through the keys of an object and returns the first key of which the callback function returns a truthy value. if it's not found it returns undefined.

*findKeyByValue(object, value): this function searches for a key in an object based on a given value.

*head(array): takes an array as its parameter and returns the first element of the array

*letterPosition(sentence): this function takes sentence as input and returns and object results where keys are unique letters in the sentence.

*map(array, callback): the function takes an array and a callback function as parameters. it applies the callback function to each element of the array and returns a new array with the results.

*middle(array): this function is designed to return the middle elements of an array.

*tail(array): this funtion returns a new array containing all elements of the input array except the first one.

*takeUntil(array, callback): takes an array and a callback function as parameters. its iterates through the array until the callback returns a truthy value, and it returns a new array containing elements from the original array until the condition is met.

*without(source, itemsToRemove); creates a new array that excludes elements specified in the itemsToRemove array from the source array.

1.0.0

6 months ago