# @b-waterman/lotide

> A utility library inspired by the Lodash project, to learn the fundamentals of programming and data management using JavaScript.

Latest version **1.0.0** (published 2023-02-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install @b-waterman/lotide
pnpm add @b-waterman/lotide
yarn add @b-waterman/lotide
bun add @b-waterman/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-02-17 |
| First published | 2023-02-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brooke Waterman |
| Maintainers | b-waterman |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2023-02-17

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

**Require it:**

`const _ = require('@b-waterman/lotide');`

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `assertArraysEqual`: function that asserts whether two arrays are equal
* `assertEqual`: A function that asserts whether two values are equal
* `assertObjectEqual`: A function that asserts whether two objects are equal
* `countLetters`: A function that returns the total number letters of a given string
* `countOnly`: A function that receives a string and only returns the total of the selected items within it
* `eqArrays`: A function that compares two arrays
* `eqObjects`: A function that compares two objects
* `findKey`: A function that takes in an object and returns the first key to return truthy
* `findKeyByValue`: A function that returns the key with the matching value
* `head`: A function that returns the first element of an array
* `letterPositions`: A function that returns the indices of each character in a given string
* `map`: A function that calls a function on every element in an array and returns a new array of the result
* `middle`: A function that returns the middle element of a given array
* `tail`: A function that retrieves the elements of the original array and returns a new array, excluding the first element
* `takeUntil`: A function that slices a given array and returns a new array with elements from the beginning
* `without`: A function that removes selected elements from an array

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