@detent/sdk 0.5.1 → 0.5.2
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 +3 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# @detent/sdk
|
|
2
2
|
|
|
3
3
|
[](https://github.com/cguillerminet/detent-sdk-ts/actions/workflows/ci.yml)
|
|
4
|
+
[](https://www.npmjs.com/package/@detent/sdk)
|
|
4
5
|
|
|
5
6
|
Typed TypeScript client for the [Detent](https://detent.dev) rate-limiting API.
|
|
6
7
|
|
|
7
|
-
> Status: pre-
|
|
8
|
+
> Status: pre-1.0 — the API may change between minor versions until 1.0.0.
|
|
8
9
|
|
|
9
10
|
## Install
|
|
10
11
|
|
|
@@ -36,7 +37,7 @@ const stats = await rg.getStats({ namespace: 'api' })
|
|
|
36
37
|
|
|
37
38
|
| Option | Default | Notes |
|
|
38
39
|
|-------------|----------------------------|--------------------------------------------------|
|
|
39
|
-
| `apiKey` | — (required) | `
|
|
40
|
+
| `apiKey` | — (required) | `dt_live_…` / `dt_test_…` |
|
|
40
41
|
| `baseUrl` | `https://api.detent.dev` | Override for self-host / tests |
|
|
41
42
|
| `timeoutMs` | `1000` | Client-side transport timeout |
|
|
42
43
|
| `failMode` | `'open'` | `'open'` allows, `'closed'` denies on transport error |
|