Skip to content

HopeHappy/lotide

Repository files navigation

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • head(array): a function that takes in an array and returns the first element in the array.
  • tail(array): a function that takes in an array and returns everything except the first element of the array.
  • eqArrays(array1, array2): a function that takes in 2 arrays and returns true if the arrays are equal and false otherwise.
  • without(source, itemsToRemove): a function that takes in a source array and an itemsToRemove arrays and returns only the items from the source array that are not in the itemsToRemove array.
  • flatten(array): a function that takes in an array that contains elements including nested array of elements and returns a flattened version of the array.
  • middle(array): a functions that takes in an array and returns middle most element of the array.
  • countOnly(allItems, itemsToCount): a function that takes in a collection of items and returns a specific subset of those items.
  • countLetters(string): a function that takes in a sentence and returns a count of each of the letters in the sentence.
  • letterPositions(string): a functions takes in a string and returns all indices of letter positions in the string.
  • findKeyByValue(object, value): a function that takes in an object and a value and returns the first key that corresponds to that value.
  • eqObjects(object1, object2): a function that takes in 2 objects and return true if they are equal and false otherwise.
  • map(array, callback): a function that takes in an array and a callback and returns a new array based on the results of the callback on each item in the array.
  • takeUntil(array, callback): a functions that takes in an array and a callback and returns a new array based on the results of the callback on each item in the array.
  • findKey(obj, callback): a function that takes in an object and callback and returns the first key that meets the criteria specified in callback.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published