1.0.0 • Published 4 years ago

@meghein/lotide v1.0.0

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

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • countLetters(...): Counts the reoccurrence of letters from a string.
  • countOny(...): Counts the reoccurrence of string(s) in an array from a list of search keys.
  • findKey(...): Scans an object and returns the first key that is true for a defined callback.
  • findKeyByValue(...): Finds an object's key by it's value.
  • flatten(...): Removes nested arrays to return a single array with all elements.
  • head(...): Returns the first element of an array.
  • letterPosition(...): Finds the index position of letters within a string and returns an object listing the results.
  • map(...): Scans an array and return a new array based on the results of a predicate.
  • middle(...): Returns the middle element(s) of the provided array. (1 number for odd arrays, 2 numbers for even)
  • takeUntil(...): Returns a slice of an inputed array from the beginning until a predicate is true.
  • tail(...): Returns the tail of an array. (Everything but the first element)
  • without(...): Take in a source array and an itemsToRemove array. It should return a new array with only those elements from source that are not present in the itemsToRemove array.
1.0.0

4 years ago