1.0.0 • Published 2 years ago

@anitat/lotide v1.0.0

Weekly downloads
3
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 @anitat/lotide

Require it:

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

Call it:

const results = _.tail([1, 2, 3]) // => [2, 3] const results = _.head([1, 2, 3]) // => [1] const results = _.middle([1, 2, 3]) // => [2] const results = _.assertArraysEqual([1, 2, 3], [1, 2, 3]) // => true const results = _.assertEqual("Lighthouse Labs", "Bootcamp") // => false const results = _.eqObjects(cd, dc) // => true const results = _.assertObjectsEqual(eqObjects(cd, dc) // => true const results = _.countLetters("hello") // => 5 const results = _.countOnly(firstNames, { "Jason": true, "Karima": true, "Fang": true, "Agouhanna": false } // => based on object declared const results = _.eqArrays([1, 2, 3], [1, 2, 3]) // => true const results = _.findKey({ "noma": { stars: 2 },}, x => x.stars === 2) // => noma const results = _.findKeyByValue(bestTVShowsByGenre, "The Wire") // => drama const results = _.map(["hi", "bye", "hello"], word => word[2]) // => ["h", "b", "h"] const results = _.takeUntil(["hi", "bye", "hello"], word => word === 'bye') // => ["hi"] const results = _.without(["1", "2", "3"], [1, 2, "3"]); // => ["1", "2"] const results = _.without(["1", "2", "3"], [1, 2, "3"]); // => ["1", "2"] const results = _.letterPositions("hello").e // => [1]

Documentation

The following functions are currently implemented:

  • head() : return first element in array
  • tail() : returns all elements except first one in array
  • middle(): returns middle element(s) in array
  • assertArraysEqual(): asserts and checks two arrays are equal
  • assertEqual(): asserts two things are stricly equal
  • assertObjectsEqual(): asserts and checks two objects are equal
  • countLetters(): counts how many letters in string
  • countOnly(): count how many times a certain element appears in array
  • eqArrays(): checks if two arrays are equal
  • eqObjects(): checks if two objects are equal
  • findKey(): returns the key based on the given callback function
  • findKeyByValue(): given a value it will return the attached key
  • letterPositions(): returns the position of a letter given
  • map(): creates a new array with the results of calling a provided function on every element in the calling array
  • takeUntil(): returns a new array taken up until a specification
  • without(): removes a specified element and returns new array
1.0.0

2 years ago