# @bavyn/lotide

> This is a mini clone of the Lodash library, created and published by me as part of my learnings at Lighthouse Labs. Not intended for use in production-grade software.

Latest version **1.0.0** (published 2023-05-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install @bavyn/lotide
pnpm add @bavyn/lotide
yarn add @bavyn/lotide
bun add @bavyn/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 | 2023-05-09 |
| First published | 2023-05-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Karma Mann |
| Maintainers | bavyn |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2023-05-09

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

**Require it:**

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

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `assertArraysEqual`: assert if two arrays are equal
* `assertEqual`: assert if two values are equal
* `assertObjectsEqual`: assert if two objects are equal
* `countLetters`: returns a count of each letter in a string
* `countOnly`: takes in a collection of items and returns counts for a specific subset of those items
* `eqArrays`: compares two arrays
* `eqObjects`: compares two objects
* `findKey`: scans an object and returns the first key for which the callback function returns a truthy value
* `findKeyByValue`: searches for a key on an object where its value matches a given value
* `head`: retrieves the first element of an array
* `letterPositions`: returns all indices in a string where each character is found
* `map`: creates a new array with the results of calling a provided function on every element in the calling array
* `middle`: returns the middle element of an array
* `tail`: retrieves all elements aside from the head of an array
* `takeUntil`: returns a slice of an array with elements taken from the beginning
* `without`: removes elements from an array

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