@thi.ng/api/README.md

Common, generic types, interfaces & mixins

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

# ![api](https://media.thi.ng/umbrella/banners-20220914/thing-api.svg?1c0ba288)

[![npm version](https://img.shields.io/npm/v/@thi.ng/api.svg)](https://www.npmjs.com/package/@thi.ng/api)
![npm downloads](https://img.shields.io/npm/dm/@thi.ng/api.svg)
[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)

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)
  - [Maintainer](#maintainer)
  - [Contributors](#contributors)
- [License](#license)

## About

Common, generic types, interfaces & mixins.

This package is implicitly used by most other projects in this repository. It
defines:

- Dozens of generic, common interfaces & types
- Class & method decorators
- Mixins
- Typedarray utilities

## Status

**STABLE** - used in production

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

## Installation

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

ES module import:

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

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

For Node.js REPL:

```text
# with flag only for < v16
node --experimental-repl-await

> const api = await import("@thi.ng/api");
```

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

## Dependencies

None

## API

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

## Authors

### Maintainer

- Karsten Schmidt ([@postspectacular](https://github.com/postspectacular))

### Contributors

- Matei Adriel ([@Mateiadrielrafael](https://github.com/Mateiadrielrafael))

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

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

## License

&copy; 2016 - 2022 Karsten Schmidt // Apache Software License 2.0