This package has been archived, and as such it is read-only.

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

@rivet-gg/actor-client@24.6.2-rc.2

Works with

Publisheda year ago (24.6.2-rc.2)

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

class Client

Client for managing & connecting to actors.

Constructors

new



Client(managerEndpointPromise: string | Promise<string>,
opts?: ClientOptions,
)

Creates an instance of Client.



create<A = unknown>(opts: CreateOptions): Promise<ActorHandle<A>>

Creates a new actor with the provided tags.



get<A = unknown>(tags: ActorTags,
opts?: GetOptions,
): Promise<ActorHandle<A>>

Gets an actor by its tags, creating it if necessary.



getWithId<A = unknown>(actorId: string,
opts?: GetWithIdOptions,
): Promise<ActorHandle>

Gets an actor by its ID.

Add Package

deno add jsr:@rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";

Import directly with a jsr specifier

import { Client } from "jsr:@rivet-gg/actor-client";

Add Package

pnpm i jsr:@rivet-gg/actor-client

or (using pnpm 10.8 or older)

pnpm dlx jsr add @rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";

Add Package

yarn add jsr:@rivet-gg/actor-client

or (using Yarn 4.8 or older)

yarn dlx jsr add @rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";

Add Package

vlt install jsr:@rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";

Add Package

npx jsr add @rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";

Add Package

bunx jsr add @rivet-gg/actor-client

Import symbol

import { Client } from "@rivet-gg/actor-client";