# @hyx131/lotide

> A mini clone of the [Lodash](https://lodash.com) library.

Latest version **1.0.1** (published 2019-07-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install @hyx131/lotide
pnpm add @hyx131/lotide
yarn add @hyx131/lotide
bun add @hyx131/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.1 |
| Published | 2019-07-01 |
| First published | 2019-07-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | hyx131 |
| Maintainers | hyx131 |

## Links

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

## Recent versions

- 1.0.1 (latest) — 2019-07-01
- 1.0.0 — 2019-07-01

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

**Require it:**

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

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `without(sourceArr, removeArr)`: takes in `sourceArr` and output the array without the items indicated on the `removeArr`.
* `takeUntil(array, callback)`: takes in an array and return new array filtered by the callback.
* `tail(array)`: return every item from the input array except for the first item.
* `middle(array)`: returns the item of the middle index from the input array. If there are an even number of items in the array, it will return the middle two items.
* `map(array, callback)`: takes in an array, parse through every index of the array with the callback function, and returns a new array with the items filtered by the callback.
* `letterPositions(string)`: takes in a sentence and returns an object with the indexes of every letter in the sentece.
* `head(array)`: returns the first element of an input array.
* `flatten(array)`: inputs an array with nested arrays, and outputs a new array without the inner arrays, but keeping the positions of the indexes the same.
* `findKeyByValue(object, value)`: takes in an object and a value, returns the key of the object that holds the input value.
* `assertArraysEqual()`: determines if arrays are equal
* `assertEqual()`: determines if strings are equal
* `assertObjectsEqual()`: determines if objects are equal
* `countLetters()`: determines letter count of an object
* `countOnly()`: determines number of times a value occurs in an array, returns an object
* `eqArrays()`: determines if arrays are equal, returns boolean
* `eqObjects()`: determines if objects are equal, returns boolean
* `findKey(object, callback)`: returns object key that matches the callback functions key finding function

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