Skip to main content
Home
Browse packagesDocsSign in
This package has been archived, and as such it is read-only.
This release is 1 version behind 24.6.2 — the latest version of @rivet-gg/actor. Jump to latest

@rivet-gg/actor@24.6.1-rc.2

rivet-gg/rivet

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

This package works with Deno
This package works with Deno
JSR Score
88%
Published
2 months ago (24.6.1-rc.2)
Report package
method Actor.prototype._onBeforeConnect
Actor.prototype._onBeforeConnect(opts: OnBeforeConnectOptions<this>): ConnState | Promise<ConnState>

Called whenever a new client connects to the actor. Clients can pass parameters when connecting, accessible via opts.parameters.

The returned value becomes the connection's initial state and can be accessed later via connection.state.

Connections cannot interact with the actor until this method completes successfully. Throwing an error will abort the connection.

Parameters

  • Options for the connection.

Return Type

ConnState | Promise<ConnState>

See

Add Package

deno add jsr:@rivet-gg/actor

Import symbol

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

---- OR ----

Import directly with a jsr specifier

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