1.0.0 • Published 2 years ago

@asiddev/lotide v1.0.0

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • `function without : removes all items from source
  • `function takeUntil: accepts an array and a callback function and runs each array element through the function, returning an array with all the items from the original array until the callback provided returns a truthy value
  • `function middle: accepts an array and returns the middle element or elements as an array
  • `function map: accepts an array and a function, and creates a new array with the results of calling the provided function on each element in the input array
  • `function letterPositions: accepts a string and returns an object with all of the indices in the string where each character was found
  • `function head: accepts an array and returns the first element
  • `function flatten: accepts an array where some elements may also be arrays and returns a single array with no inner arrays (a "flattened" version of the input array)
  • `function findKeyByValue: accepts an object and a value: scans the object and returns the first key which contains the given value
  • `function findKey: accepts an object and a callback function: scans the object and returns the first key for which the callback function returns a truthy value
  • `function eqObjects: accepts two objects and returns true or false based on if they are equal
  • `function eqArrays: accepts two arrays and returns true or false based on if they are equal
  • `function countOnly: accepts a string and returns an object with key value pairs to denote each character in the string, and the number of times it occured in the string
  • `function countLetters: accepts a string and returns an object with key value pairs to denote each character in the string, and the number of times it occured in the string
  • `function assertObjectsEqual: accepts two objects and returns true or false based on if they are equal
  • `function assertEqual: accepts two strings and returns true or false based on if they are equal
  • `function assertArraysEqual: accepts two arrays and returns true or false based on if they are equal
  • `function tail: accepts an array and returns the same array, but with the first element removed