https://github.com/quackness/lotide

https://github.com/quackness/lotide

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/quackness/lotide
• Owner: quackness
• Created: 2022-01-26T21:20:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-16T16:19:45.000Z (almost 3 years ago)
• Last Synced: 2024-12-15T10:35:07.604Z (about 1 month ago)
• Language: JavaScript
• Size: 49.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Lotide

A mini clone of the [Lodash](https://lodash.com) 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 @reddenkarolina/lotide`

**Require it:**

`const _ = require('@reddenkarolina/lotide');`

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `function1(assertEqual)`: takes in 2 values and returns true if they are equal and false otherwise

* `function2(head)`: takes in an array and returns the first element in the array

* `function3(tail)`:  takes in an array and returns everything except the first element of the array

* `function4(eqArrays)`: takes in 2 arrays and returns true if the arrays are equal and false otherwise

* `function5(assertArraysEqual)`:  takes in 2 arrays and returns true if they are equal and false otherwise

* `function6(without)`: 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

* `function7(flatten)`: takes in an array that contains elements including nested array of elements and returns a flattened version of the array.

* `function8(middle)`: takes in an array and returns middle most element of the array

* `function9(countOnly)`: takes in a collection of items and returns a specific subset of those items

* `function10(countLetters)`: takes in a sentence and returns a count of each of the letters in the sentence

* `function11(letterPositions)`: takes in a string and returns all indices of letter positions in the string

* `function12(findKeyByValue)`: takes in an object and a value and returns the first key that corresponds to that value

* `function13(eqObjects)`: takes in 2 objects and return true if they are equal and false otherwise

* `function14(assertObjectsEqual)`: takes in 2 objects and returns true if they are equal and false otherwise 

* `function15(map)`: 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

* `function16(takeUntil)`: takes in an array and callback and returns a slice of the array based on the criteria specified in the callback

* `function17(findKey)`: takes in an object and callback and returns the first key that meets the criteria specified in callback