# @ethanw03/lotide

> lotide project

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

## Install

```sh
npm install @ethanw03/lotide
pnpm add @ethanw03/lotide
yarn add @ethanw03/lotide
bun add @ethanw03/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-01-17 |
| First published | 2023-01-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ethan Wong |
| Maintainers | ethanw03 |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2023-01-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 @ethanw03/lotide`

**Require it:**

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

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `assertArrayEquals(arr1, arr2)`: console logs whether two arrays are equal
* `assertEqual(actual, expected)`: console logs whether two inputs are equal
* `assertObjectEqual(actual, expected)`: console logs whether two objects are equal
* `countLetters(sentence)`: counts the total amount of letters in a sentence and console logs the amount of the letter most used
* `countOnly(allItems, itemsToCount)`: counts the amount of times the item appears in the object.
* `eqArrays(arr1, arr2)`: checks to see if two arrays are equal
* `eqObjects(object1, object2)`: checks to see if two objects are equal.
* `findKey(object, callback)`: returns the key of the value outputted from the callback function
* `keyByValue(object, value)`: returns the corresponding key from the value.
* `head(arr)`: returns the first element of a given array
* `letterPositions(sentence)`: returns the index position(s) of a letter within a string
* `map(array, callback)`: returns the letter at a certain index for each word in a string
* `middle(array)`: returns the middle index(s) of an array
* `tail(arr)`: returns the array without it's first value
* `takeUntil(array, callback)`: returns the array up until the condition of the callback function is satisfied
* `without(source, itemsToRemove)`: removes an item from the array and returns the array without the given item

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