1 |
|
2 |
|
3 | # ![@thi.ng/checks](https://media.thi.ng/umbrella/banners-20230807/thing-checks.svg?8a250e50)
|
4 |
|
5 | [![npm version](https://img.shields.io/npm/v/@thi.ng/checks.svg)](https://www.npmjs.com/package/@thi.ng/checks)
|
6 | ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/checks.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 190 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 | Collection of 70+ type, feature & value checks.
|
28 |
|
29 | ## Status
|
30 |
|
31 | **STABLE** - used in production
|
32 |
|
33 | [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bchecks%5D+in%3Atitle)
|
34 |
|
35 | ## Installation
|
36 |
|
37 | ```bash
|
38 | yarn add @thi.ng/checks
|
39 | ```
|
40 |
|
41 | ES module import:
|
42 |
|
43 | ```html
|
44 | <script type="module" src="https://cdn.skypack.dev/@thi.ng/checks"></script>
|
45 | ```
|
46 |
|
47 | [Skypack documentation](https://docs.skypack.dev/)
|
48 |
|
49 | For Node.js REPL:
|
50 |
|
51 | ```js
|
52 | const checks = await import("@thi.ng/checks");
|
53 | ```
|
54 |
|
55 | Package sizes (brotli'd, pre-treeshake): ESM: 1.65 KB
|
56 |
|
57 | ## Dependencies
|
58 |
|
59 | - [tslib](https://www.typescriptlang.org/)
|
60 |
|
61 | ## API
|
62 |
|
63 | [Generated API docs](https://docs.thi.ng/umbrella/checks/)
|
64 |
|
65 | TODO
|
66 |
|
67 | ## Authors
|
68 |
|
69 | - [Karsten Schmidt](https://thi.ng) (Main author)
|
70 | - [Gavin Cannizzaro](https://github.com/gavinpc-mindgrub)
|
71 | - [Jay Zawrotny](https://github.com/eccentric-j)
|
72 |
|
73 | If this project contributes to an academic publication, please cite it as:
|
74 |
|
75 | ```bibtex
|
76 | @misc{thing-checks,
|
77 | title = "@thi.ng/checks",
|
78 | author = "Karsten Schmidt and others",
|
79 | note = "https://thi.ng/checks",
|
80 | year = 2016
|
81 | }
|
82 | ```
|
83 |
|
84 | ## License
|
85 |
|
86 | © 2016 - 2024 Karsten Schmidt // Apache License 2.0
|