# @brynschulha/lotide

> brynschulha's lotide library

Latest version **1.0.0** (published 2020-09-21) · ISC license · 0 weekly downloads

## Install

```sh
npm install @brynschulha/lotide
pnpm add @brynschulha/lotide
yarn add @brynschulha/lotide
bun add @brynschulha/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 | 2020-09-21 |
| First published | 2020-09-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bryn Schulha |
| Maintainers | brynschulha |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2020-09-21

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

**Require it:**

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

**Call it:**

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

## Documentation

The following functions are currently implemented:

* `head(someArray)`: returns the first element of an array
* `tail(someArray)`: returns everything after the first element in an array
* `middle(array)`: returns the middle element of an array
* `assertArraysEqual(actual, expected)`: prints an assertion that two arrays are equal or not
* `assertEqual(actual, expected)`: determines equality
* `assertObjectsEqual(actual, expected)`: prints an assertion that two objects are equal or not
* `countLetters(stringInput)`: counts the number of letters in a string
* `countOnly(allItems, itemsToCount)`: counts the number of a specified element
* `eqArrays(array1, array2)`: determines if two arrays are equal
* `eqObjects(object1, object2)`: determines if two objects are equal
* `findKey(object, callback)`: returns a key that has a value that matches the output of a callback
* `findKeyByValue(object, value)`: returns a key given a value
* `letterPositions(sentence)`: prints all the letters of a sentence and which index number(s) they appear at
* `map(array, callback)`: loops through elements in an array and performs a callback function on them, then stores them in a new array
* `takeUntil(arr, callback)`: will return elements in an array until a certain element is reached which is determined by a callback function
* `without(source, itemsToRemove)`: takes an array and removes certain specified elements then returns what is left

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