# @briankendalbucek/lotide

> Lotide library project for LHL

Latest version **1.0.1** (published 2022-08-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @briankendalbucek/lotide
pnpm add @briankendalbucek/lotide
yarn add @briankendalbucek/lotide
bun add @briankendalbucek/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 | 2022-08-06 |
| First published | 2022-08-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brian Bucek |
| Maintainers | briankendalbucek |

## Links

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

## Dependencies (1)

- [my-package](https://npm.io/package/my-package.md) 0.0.0

## Recent versions

- 1.0.1 (latest) — 2022-08-06
- 1.0.0 — 2022-08-05

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

**Require it:**

`const _ = require('@briankendalbucek/lotide');`
`Mocha`
`Chai`

**Call it:**

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


## Documentation

The following functions are currently implemented:

* `Head`: Return the first item in an array and undefined if the array is empty.
* `Tail`: Returns everything minus the first item in the array. If array is empty returns [].
* `Without`: Returns an array minus the unwanted elements.
* `Flatten`: Returns a flat array compiled of all indexes in the multi-nested array.
* `Middle`: Returns the middle element if array is odd, and two middle elements if even. If only one or two elements, it will return [].
* `CountOnly`: Takes a collection of items and returns a count for a specific subset of those items. Limited to strings.
* `CountLetters`: Returns counts for specified characters of an inputted string.
* `LetterPositions`: Return all of the indices of where each character is found in the string.
* `FindKeyByValue`: Return the first key with the value of the inputted object and value. Return undefined if not found.
* `Map`: Returns a new array in function that takes two args. Both an array to map and a callback.
* `TakeUntil`: Takes an array and a callback as parameters and returns a truthy value.
* `FindKey`: Takes an object and a call back as parameters and returns a truthy value. Return undefind if no key is found.

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