@thi.ng/api/README.md

Common, generic types, interfaces & mixins

<!-- This file is generated - DO NOT EDIT! -->
<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
# ![@thi.ng/api](https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/banners/thing-api.svg?e8743272)

[![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)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)

> [!NOTE]
> This is one of 206 standalone projects, maintained as part
> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
> and anti-framework.
>
> 🚀 Please help me to work full-time on these projects by [sponsoring me on
> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️

- [About](#about)
- [Status](#status)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [API](#api)
- [Authors](#authors)
- [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
```

ESM import:

```ts
import * as api from "@thi.ng/api";
```

Browser ESM import:

```html
<script type="module" src="https://esm.run/@thi.ng/api"></script>
```

[JSDelivr documentation](https://www.jsdelivr.com/)

For Node.js REPL:

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

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

## Dependencies

None

## API

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

## Authors

- [Karsten Schmidt](https://thi.ng) (Main author)
- [Matei Adriel](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 - 2025 Karsten Schmidt // Apache License 2.0