1.0.0 • Published 4 years ago

@jaredflomen/lotide v1.0.0

Weekly downloads
1
License
ISC
Repository
github
Last release
4 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 @JaredFlomen/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • function1(head): outputs the head (index0) of an array.
  • function2(tail): outputs the tail (every value expect the head -> index0) of an array.
  • function3(middle): returns the middle value of an array, that array will be 2 values if the length is even.
  • funciton4(without): removes elements from an array, those elements must have the same type and value to what is being asked to be removed.
  • funciton5(map): given an array containing strings, the map function will return a new array with the first letter in each string.
  • funciton6(findKey): findKey will output a key from an object, using a callback function that determines which key to look for.
  • funciton7(takeUntil): takeUntil will iterate through an array of strings until it stops, that break is determined through a callback function.
  • funciton8(letterPositions): letterPositions outputs an object that contains each unique letter of a string, along with it's index position of that original string.
  • function9(findKeyByValue): this function searches an object for a given value, and outputs it's corresponding key.
  • funciton10(countLetters): this function returns an object containing each letter in a string, along with the amount of times that the letter is contained within the test string.
  • function11(countOnly): countOnly outputs the amount of times a test string is found within an object, along with testing if that test string should be counted or not.
  • function12(assertEqual): assertEqual is a blunt force tool designed to check if an input (actual) is the same type and value as an expected value.
  • function13(assertObjectsEqual): assertObjectsEqual will test if two objects are the same, including: values, types and array lengths. Array lengths are tested if values are contained within a key instead of single numbers or strings.
  • function14(eqObjects): eqObjects works with assertObjectsEqual by testing if two objects are the same.
  • function15(eqArrays): eqArrays tests if two arrays are the same.
  • function16(assertArraysEqual): assertArraysEqual is a function that outputs to the console if two arrays (an actual array and an expect array) are equal.