@ill-eagle/lotide

1.0.0 • Public • Published

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 @ill-eagle/lotide

Require it:

const _ = require('@ill-eagle/lotide');

Call it:

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

Documentation

The following functions are currently implemented:

  • assertArraysEqual(arr1, arr2): Asserts whether or not two arrays are equal, using the eqArray function.

  • assertEqual(actual, expected): Asserts whether or not two values are equal.

  • assertObjectsEqual(object1, object2): Asserts whether two objects are equal by comparing their properties using the eqObjects function.

  • countLetters(string): Counts the number of letters in a string, excluding spaces.

  • countOnly(allItemsArray, itemsToCount): Counts the number of instances of a given value within an array.

  • eqArray(arr1, arr2): Returns a boolean value if two arrays are equal or not.

  • eqObjects(object1, object2): Returns a boolean value of whether or not two objects are equal.

  • findByKeyValue(object, value): Finds the value of a key within a given object.

  • findKey(object, function): Returns a key(s) within an object that aligns with the given callback function.

  • flatten(array): Flattens an array one level, removing nested arrays.

  • head(array): Returns the first item in an array.

  • letterPositions(string): Returns the indices where each character is found in a given string.

  • map(array, callback): Returns an array of each element in the array as modified by the callback function.

  • middle(array): Returns the middle value in an array for oddly-numbered, and the middle two digits for evenly-numbered.

  • tail(array): Returns the final element in an array.

  • takeUntil(array, callback): Returns elements of the array until a condition specified by the callback function is met.

  • without(source, toRemove): Returns the source array with the desired element removed.

Readme

Keywords

none

Package Sidebar

Install

npm i @ill-eagle/lotide

Weekly Downloads

2

Version

1.0.0

License

ISC

Unpacked Size

17.8 kB

Total Files

27

Last publish

Collaborators

  • ill-eagle