1.0.0 • Published 2 years ago

@jamesmurphy/lotide v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 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 @jamesmurphy/lotide

Require it:

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

Call it:

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

Documentation

The following functions are currently implemented:

const assertArrayEqual = function(actual, expected): Passes two arrays and determines if they are equal or not.

const assertEqual = function(actual, expected): Passes two values and determines if they are equal or not.

const assertObjectsEqual = function(actual, expected): Passes two objects and determines if they are equal or not.

const countLetters = function (string): Passes a string and counts the number of letters in it.

const countOnly = function(allItems, itemsToCount): Passes an array of strings and only returns what the object (itemsToCount) specifies.

const eqArrays = function (actual, expected): Passes two arrays and outputs whether or not they are equal to each other.

const eqObjects = function(object1, object2): Passes two objects and outputs if they are equal or not.

const findKey = function(object, callback): Passes an object and finds the key based upon its value.

const findKeyByValue = function (object, value): Passes an object and finds the key through its value.

const flatten = function(array): Un-nests a nested array.

const head = function(actual): Returns the first item in an array.

const letterPositions = function(sentence): Passes a string and returns an object that counts each letter that the string contains.

const map = function(array, callback): Passes an array of strings or numbers and returns a mutated value for each item in the array of that index.

const middle = function(array): Passes an array and returns its middle value.

const tail = function(actual): Passes an array and returns the last value in the array.

const takeUntil = function(array, callback): Passes an array and returns a new array that stops where the callback indicates.

const without = function(array, remove): Passes an array and removes the specified item.