# @kacsokz/lotide

> Mini clone of Lodash Library, for education purposes only

Latest version **1.0.0** (published 2019-07-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install @kacsokz/lotide
pnpm add @kacsokz/lotide
yarn add @kacsokz/lotide
bun add @kacsokz/lotide
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-07-30 |
| First published | 2019-07-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Casey Sokach, student at Lighthouse Labs |
| Maintainers | kacsokz |

## Links

- npm: https://www.npmjs.com/package/@kacsokz/lotide
- Repository: https://github.com/kacsokz/Lotide
- Homepage: https://github.com/kacsokz/Lotide#readme
- Issues: https://github.com/kacsokz/Lotide/issues
- npm.io page: https://npm.io/package/@kacsokz/lotide

## Dependencies (1)

- [chai](https://npm.io/package/chai.md) ^4.2.0

## Recent versions

- 1.0.0 (latest) — 2019-07-30

## 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 @kacsokz/lotide`

**Require it:**

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

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `assertArraysEqual(actual, expected)`: equality assertion for two arrays
* `assertEqual(actual, expected)`: strict equality assertion for two values
* `assertObjectsEqual(actual, expected)`: equality assertion for two objects
* `countLetters(allLetters, lettersToCount)`: counts letters in string allLetters, in object lettersToCount
* `countOnly(allItems, itemsToCount)`: counts items in array allItems, based on object itemsToCount 
* `eqArrays(arr1, arr2)`: compares two arrays for equality
* `eqObjects(object1, object2)`: compares two objects for equality
* `findKey(obj, callback)`: returns first key based on parameters of callback
* `findKeyByValue(obj, val)`: returns first key based on a specified value
* `flatten(nestedArray)`: returns a flattened array, from a nested array
* `head(arr)`: returns head on an array
* `letterPositions(str)`: returns all indices of each letter in the sentence
* `map(arr1, arr2)`: shallow version of the iterator map
* `middle(arr)`: returns middle element(s) of an array
* `min(numbers)`: returns the smallest number in an array
* `tail(arr)`: returns tail of an array
* `takeUntil(array, callback)`: pushes array elements into a new array until the stopping condition in callback is met
* `without(source, itemsToRemove)`: returns a new, filtered array, removing any itemsToRemove that match source

---
_Source: https://npm.io/package/@kacsokz/lotide · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._