docs: @rudder/sdk 0.2.1, readme and skill describe guarantees, not internals
This commit is contained in:
@@ -5,19 +5,19 @@ description: Use when working with the Rudder TypeScript/JavaScript client SDK (
|
||||
|
||||
# Rudder Web SDK (@rudder/sdk)
|
||||
|
||||
Client SDK for web games on the Rudder LiveOps platform. Source of truth:
|
||||
`liveops-web-sdk/src` (wire types in `src/generated` come from
|
||||
`liveops-backend/apigen`; never edit them by hand).
|
||||
Client SDK for web games on the Rudder LiveOps platform. Source of truth: the
|
||||
package source and its type declarations (wire types in `src/generated` are
|
||||
generated; never edit them by hand).
|
||||
|
||||
0.2.0 covers only the kernel: auth, player, catalog, storage, module calls and
|
||||
internal revision sync. Game features are installed modules, reached through a
|
||||
0.2.1 covers only the kernel: auth, player, catalog, storage, module calls and
|
||||
background sync. Game features are installed modules, reached through a
|
||||
typed client generated from their manifests. There is no `resources(slug)` and
|
||||
no `projectStorage`; game-facing configuration comes from modules such as
|
||||
`remote_config`.
|
||||
|
||||
## Install
|
||||
|
||||
Published to the Gitea registry at hub.rudder.build, not npmjs. Point the
|
||||
Published to the Rudder package registry at hub.rudder.build, not npmjs. Point the
|
||||
`@rudder` scope at it in `.npmrc` (anonymous read, no token):
|
||||
|
||||
```
|
||||
|
||||
@@ -58,7 +58,7 @@ client.modules.call<T = unknown>(
|
||||
`result`. Console output and the kernel call log never reach players.
|
||||
- Idempotency: each call generates one `Idempotency-Key` (UUID v4) and sends
|
||||
the same key on every retry, so the server runs the function at most once
|
||||
and returns the stored response for a repeated key. A new `call()` gets a
|
||||
and a retry with the same key within 24 h returns the first response. A new `call()` gets a
|
||||
new key.
|
||||
- Retries: up to 2, with jittered exponential backoff, on network errors, 5xx
|
||||
and 409 with code `conflict`. Other 4xx responses (including other 409
|
||||
|
||||
Reference in New Issue
Block a user