1.0.1 • Published 5 years ago

@eliks/lotide v1.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
5 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 @eliks/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • countLetters('string'): counts the letters in a string
  • countOnly(['allItems'], {itemsToCount): takes an array of strings and an object containing a string and boolean key value pair. returns the amount of times each specificed string in the key value pair appears in the array of strings.
  • findKey(object, key): takes an object and a value as input and searches the object to see if a key with that value exists. if it does it returns the key.
  • findKeyByValue(object, value): takes an object and value and returns the key that has that value if it exists.
  • tail([array]): takes an array and returns an array containing the values of indexes after index 0.
  • head([array]): takes an array and returns the first index in the array.
  • middle([array]): takes an array and returns the value of the middlde index or indexs of that array.
  • map([array], callback): takes an array and a callback value. returns an array that is the original array morphed according to the callback function.
  • letterPositions(sentence): takes a setence and returns an object containing key value pairs of each letter in the sentence and what index or indexs it appears at.
  • takeUntil([array], callback): takes an array and a callback. Returns a new array containing all values of the original array until the callback value is read.
  • without([array], toRemove): takes an array and an input and removes the input from the array.
  • flatten([array]): takes an array of nested arrays and returns an array with all the values of the nested arrays.
1.0.1

5 years ago

1.0.0

5 years ago