Skip to main content
This release is 0 versions behind 24.6.1 — the latest version of @rivet-gg/actor-client. Jump to latest

🔧 Rivet Actors have built-in RPC, state, and events — the easiest way to build modern applications.

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
64%
Published
2 days ago (24.6.1-rc.2)
T
ActorHandle

Connection to an actor. Allows calling actor's remote procedure calls with inferred types. See ActorHandleRaw for underlying methods.

c
ActorHandleRaw

Provides underlying functions for ActorHandle. See ActorHandle for using type-safe remote procedure calls.

T
ActorRPCFunction

RPC function returned by ActorHandle. This will call ActorHandle.rpc when triggered.

c
Client

Client for managing & connecting to actors.

I
ClientOptions

Options for configuring the client.

I
CreateOptions

Options for creating an actor.

I
CreateRequest

Interface representing a request to create an actor.

T
EventUnsubscribe

A function that unsubscribes from an event.

I
GetOptions

Options for getting an actor.

I
GetWithIdOptions

Options for getting an actor by ID.

T
ProtocolFormat

Protocol format used to communicate between the client & actor.

I
QueryOptions

Options for querying actors.

I
Region

Represents a region to connect to.

f
readEndpointFromCli

Uses the Rivet CLI to read the manager endpoint to connect to. This allows for writing tests that run locally without hardcoding the manager endpoint.

c
TestClient
No documentation available