@truenas/api-client 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/dist/index.cjs +1954 -51
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +25403 -43
- package/dist/index.d.ts +25403 -43
- package/dist/index.js +1946 -52
- package/dist/index.js.map +1 -1
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -11,6 +11,17 @@ Framework-agnostic TypeScript client for the TrueNAS JSON-RPC 2.0 WebSocket API.
|
|
|
11
11
|
implementation (e.g. the [`ws`](https://www.npmjs.com/package/ws) package) via the socket config.
|
|
12
12
|
- **`rxjs` ^7.8** is a peer dependency — the consuming project provides it.
|
|
13
13
|
|
|
14
|
+
## Documentation
|
|
15
|
+
|
|
16
|
+
The API reference is generated from the TSDoc comments in the source with
|
|
17
|
+
[TypeDoc](https://typedoc.org/) and published to GitHub Pages with each npm release:
|
|
18
|
+
<https://truenas.github.io/api-client-ts/>
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
yarn docs # generate locally into docs/ (gitignored)
|
|
22
|
+
yarn docs:check # validate doc comments without rendering (run in CI)
|
|
23
|
+
```
|
|
24
|
+
|
|
14
25
|
## Development
|
|
15
26
|
|
|
16
27
|
```bash
|