ContextQMD
Back to Rivet

Metadata

website/src/content/docs/actors/metadata.mdx

2.2.12.5 KB
Original Source

Actor ID

Get the unique instance ID of the actor:

typescript
import { actor } from "rivetkit";

const example = actor({
	state: {},
	actions: {
		getId: (c) => {
			const actorId = c.actorId;
			return actorId;
		},
	},
});

Actor Name

Get the actor type name:

typescript
import { actor } from "rivetkit";

const example = actor({
	state: {},
	actions: {
		getName: (c) => {
			const actorName = c.name;
			return actorName;
		},
	},
});

This is useful when you need to know which actor type is running, especially if you have generic utility functions that are shared between different actor implementations.

Actor Key

Get the actor key used to identify this actor instance:

typescript
import { actor } from "rivetkit";

const example = actor({
	state: {},
	actions: {
		getKey: (c) => {
			const actorKey = c.key;
			return actorKey;
		},
	},
});

The key is used to route requests to the correct actor instance and can include parameters passed when creating the actor.

Learn more about using keys for actor addressing and configuration in the keys documentation.

Region

Region can be accessed from the context object via c.region.

typescript
import { actor } from "rivetkit";

const example = actor({
	state: {},
	actions: {
		getRegion: (c) => {
			const region = c.region;
			return region;
		},
	},
});

<Warning>c.region is only supported on Rivet at the moment.</Warning>

Example Usage

<CodeGroup workspace>
typescript
import { actor, setup } from "rivetkit";

const chatRoom = actor({
	state: {
		messages: [],
	},

	actions: {
		// Get actor metadata
		getMetadata: (c) => {
			return {
				actorId: c.actorId,
				name: c.name,
				key: c.key,
				region: c.region,
			};
		},
	},
});

export const registry = setup({
	use: { chatRoom },
});

registry.start();
typescript
import { createClient } from "rivetkit/client";
import type { registry } from "./index";

const client = createClient<typeof registry>("http://localhost:6420");

// Connect to a chat room
const chatRoomHandle = client.chatRoom.get(["general"]);

// Get actor metadata
const metadata = await chatRoomHandle.getMetadata();
console.log("Actor metadata:", metadata);
</CodeGroup>

API Reference