# @kinchan/io

> pleasant input, happy output.

Latest version **1.1.2** (published 2022-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kinchan/io
pnpm add @kinchan/io
yarn add @kinchan/io
bun add @kinchan/io
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2022-04-11 |
| First published | 2022-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kinchan |
| Maintainers | kinchan |
| Keywords | kinchan, io |

## Links

- npm: https://www.npmjs.com/package/@kinchan/io
- Repository: https://github.com/dev-kinchan/io
- Issues: https://github.com/dev-kinchan/io/issues
- npm.io page: https://npm.io/package/@kinchan/io

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2022-04-11
- 1.1.1 — 2022-04-11
- 1.1.0 — 2022-03-31

## README

<img src="https://github.com/dev-kinchan/io/blob/main/assets/io-logo.png?raw=true" width="200" height="200">

# io

Pleasantly useful functions that brightens your day.

`io` started as a personal project intended to assimilate lodash's functionality.

## Before You Jump the Gun

This package is intended for test use only. It may not suited for production. Please use at your own risk.

## Instillation

```bash
npm install @kinchan/io
```

## Basic Usage

```js
import {
    maxIndex
    within
} from "@kinchan/io";

maxIndex([1, 2, 3])
// -> 2

within(5, ["a", "b", "c"])
// -> false
```

## API Reference

Type definition files are included in this package. 

Examples are written in each module's test file. You can reference them on GitHub repo.

### Array

`maxIndex` : (array: any[]) => number

`within` : (index: number, array: any[]) => boolean

`outOfRange` : (index: number, array: any[]) => boolean

`complied` : (array: any[], index: number) => number

`last` or `latest` : (array: Type[]) => Type | undefined

### Object

`reveal` : (data: object | undefined | null) => object

### String

`trimmed` : (text: string) => string

editing...

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