1 |
|
2 |
|
3 | # ![@thi.ng/api](https://media.thi.ng/umbrella/banners-20230807/thing-api.svg?1c0ba288)
|
4 |
|
5 | [![npm version](https://img.shields.io/npm/v/@thi.ng/api.svg)](https://www.npmjs.com/package/@thi.ng/api)
|
6 | ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/api.svg)
|
7 | [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
|
8 |
|
9 | > [!NOTE]
|
10 | > This is one of 192 standalone projects, maintained as part
|
11 | > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
|
12 | > and anti-framework.
|
13 | >
|
14 | > 🚀 Please help me to work full-time on these projects by [sponsoring me on
|
15 | > GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
|
16 |
|
17 | - [About](#about)
|
18 | - [Status](#status)
|
19 | - [Installation](#installation)
|
20 | - [Dependencies](#dependencies)
|
21 | - [API](#api)
|
22 | - [Authors](#authors)
|
23 | - [License](#license)
|
24 |
|
25 | ## About
|
26 |
|
27 | Common, generic types, interfaces & mixins.
|
28 |
|
29 | This package is implicitly used by most other projects in this repository. It
|
30 | defines:
|
31 |
|
32 | - Dozens of generic, common interfaces & types
|
33 | - Class & method decorators
|
34 | - Mixins
|
35 | - Typedarray utilities
|
36 |
|
37 | ## Status
|
38 |
|
39 | **STABLE** - used in production
|
40 |
|
41 | [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bapi%5D+in%3Atitle)
|
42 |
|
43 | ## Installation
|
44 |
|
45 | ```bash
|
46 | yarn add @thi.ng/api
|
47 | ```
|
48 |
|
49 | ESM import:
|
50 |
|
51 | ```ts
|
52 | import * as api from "@thi.ng/api";
|
53 | ```
|
54 |
|
55 | Browser ESM import:
|
56 |
|
57 | ```html
|
58 | <script type="module" src="https://esm.run/@thi.ng/api"></script>
|
59 | ```
|
60 |
|
61 | [JSDelivr documentation](https://www.jsdelivr.com/)
|
62 |
|
63 | For Node.js REPL:
|
64 |
|
65 | ```js
|
66 | const api = await import("@thi.ng/api");
|
67 | ```
|
68 |
|
69 | Package sizes (brotli'd, pre-treeshake): ESM: 2.41 KB
|
70 |
|
71 | ## Dependencies
|
72 |
|
73 | None
|
74 |
|
75 | ## API
|
76 |
|
77 | [Generated API docs](https://docs.thi.ng/umbrella/api/)
|
78 |
|
79 | ## Authors
|
80 |
|
81 | - [Karsten Schmidt](https://thi.ng) (Main author)
|
82 | - [Matei Adriel](https://github.com/Mateiadrielrafael)
|
83 |
|
84 | If this project contributes to an academic publication, please cite it as:
|
85 |
|
86 | ```bibtex
|
87 | @misc{thing-api,
|
88 | title = "@thi.ng/api",
|
89 | author = "Karsten Schmidt and others",
|
90 | note = "https://thi.ng/api",
|
91 | year = 2016
|
92 | }
|
93 | ```
|
94 |
|
95 | ## License
|
96 |
|
97 | © 2016 - 2024 Karsten Schmidt // Apache License 2.0
|