1.0.3 • Published 2 years ago

@akatyal/lotide v1.0.3

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Lotide

A mini clone of the Lodash library.

A Lighthouse Labs project by Arushi Katyal.

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

Require it:

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

Call it:

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

Documentation

assertArraysEqual.js

  • a function which utilizes eqArrays.js to compare two arrays for an exact match, then prints a pass or fail assertion

assertEqual.js

  • 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.js

  • a function which takes two parameters, the actual object, and the expected object, and returns an assertion passed or failed

countLetters.js

  • a function that accepts a string of characters. It then returns an object with a tally of characters

countOnly.js

  • a function that accepts an array of names, and an object of names you wish to make a tally of. Returns a new object with a name count

eqArrays.js

  • a function which compares two arrays and returns true or false, based on a perfect match.

eqObjects.js

  • a function which compares two objects to see if both objects have identical keys with identical values.

findKey.js

  • 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.

findByKeyValue.js

  • a function that searches for a key on an object where its value matches a given value

flatten.js

  • a function that accepts a nested array with infinite levels of nesting as an argument, and returns a single "flattened" array

head.js

  • a function which accepts an array as an argument, and returns the head of the array

letterPositions.js

  • a function that accepts a string of characters. It then returns an object with an array for each character present

map.js

  • a function that creates a new array populated with results of a callback function on every element in a specified array

middle.js

  • a function that accepts an array, and returns the middle index value(s) in a new array

tail.js

  • a function which accepts an array as an argument, and returns the tail of the array

takeUntil.js

  • a function that will collect items from a provided array until the callback function provided returns a truthy value

without.js

  • a function that accepts two arrays: the source array, and an "itemsToRemove" array. It returns a new array with the items removed.