@thi.ng/checks/README.md

Collection of 70+ type, feature & value checks

<!-- This file is generated - DO NOT EDIT! -->

# ![@thi.ng/checks](https://media.thi.ng/umbrella/banners-20220914/thing-checks.svg?8a250e50)

[![npm version](https://img.shields.io/npm/v/@thi.ng/checks.svg)](https://www.npmjs.com/package/@thi.ng/checks)
![npm downloads](https://img.shields.io/npm/dm/@thi.ng/checks.svg)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)

This project is part of the
[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.

- [About](#about)
- [Status](#status)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [API](#api)
- [Authors](#authors)
- [License](#license)

## About

Collection of 70+ type, feature & value checks.

## Status

**STABLE** - used in production

[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bchecks%5D+in%3Atitle)

## Installation

```bash
yarn add @thi.ng/checks
```

ES module import:

```html
<script type="module" src="https://cdn.skypack.dev/@thi.ng/checks"></script>
```

[Skypack documentation](https://docs.skypack.dev/)

For Node.js REPL:

```js
const checks = await import("@thi.ng/checks");
```

Package sizes (brotli'd, pre-treeshake): ESM: 1.59 KB

## Dependencies

- [tslib](https://www.typescriptlang.org/)

## API

[Generated API docs](https://docs.thi.ng/umbrella/checks/)

TODO

## Authors

- [Karsten Schmidt](https://thi.ng) (Main author)
- [Gavin Cannizzaro](https://github.com/gavinpc-mindgrub)
- [Jay Zawrotny](https://github.com/eccentric-j)

If this project contributes to an academic publication, please cite it as:

```bibtex
@misc{thing-checks,
  title = "@thi.ng/checks",
  author = "Karsten Schmidt and others",
  note = "https://thi.ng/checks",
  year = 2016
}
```

## License

&copy; 2016 - 2023 Karsten Schmidt // Apache License 2.0