1.0.0 • Published 3 years ago

@brycemclachlan/lotide v1.0.0

Weekly downloads
3
License
UNLICENSED
Repository
github
Last release
3 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 @brycemclachlan/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

  • function tail: Takes an array and return everything after the first element

  • function pipe: Takes any number and returns a composite functions where one functions returns into the next ones arguments.

  • function countOnly: Takes two arguments. The first one is an array of strings to look through. The second argument is what the function is looking for. It will return the amount of times the second argument appears in the first argument.

  • function findKeyByValue: Takes two arguments. The first is an object. The second argument is a number or string that is used to search though the values for each of the keys and returns the key when a match is found.

  • function assertEqual: Checks if two arguments are equal. Returns a boolean.

  • function flatten: Takes an array with nested arrays and returns an array that has been flattened.

  • function flipFlatObject: Takes an object and flips the keys and values then returns the flipped object.

  • function assertObjectsEqual: Checks if two arguments are equal. Returns a boolean.

  • function head: Takes an array and returns the first element.

  • function middle: Takes an array and returns an array with the middle elements as an array. If the original array length is odd it will return an array with a length of one, if original array length is even it will return an array with a length of two.

  • function eqArrays: Checks if two arguments are equal. Returns a boolean.

  • function isEqual: Checks if two arguments are equal. Returns a boolean.

  • function takeUntil: Takes an array and an element. Will return the original array up to the where the element is found in the array.

  • function findKey: For each key it will look though a nested object and find a key that matches.

  • function assertArraysEqual: Checks if two arguments are equal. Returns a boolean.

  • function countLetters: Takes a string and returns an object with how many of each character is found.

  • function eqObjects: Checks if two arguments are equal. Returns a boolean.

  • function map: Takes an array and a function. It will return a new array where each element has been run though the function.

  • function letterPositions: Takes a string and returns an object with each character of the string as the key and value being an array of indexes of where the character was found in the original string.

  • function without: Takes two arrays. The first array will be returned without any of the elements of the second array.