# Interface ActorOptions<Registry, ActorName>

Options for configuring a actor in RivetKit.

interface ActorOptions<
Registry extends AnyActorRegistry,
ActorName extends keyof ExtractActorsFromRegistry<Registry>,
> {
createInRegion?: string;
createWithInput?: unknown;
enabled?: boolean;
key: string | string[];
name: ActorName;
params?: Registry[ExtractActorsFromRegistry<Registry>]["params"];
}

#### Type Parameters

- Registry extends AnyActorRegistry
- ActorName extends keyof ExtractActorsFromRegistry<Registry>

- Defined in mod.d.ts:72

##### Index

### Properties

createInRegion?
createWithInput?
enabled?
key
name
params?

## Properties

### `Optional` createInRegion

createInRegion?: string

Region to create the actor in if it doesn't exist.

- Defined in mod.d.ts:90

### `Optional` createWithInput

createWithInput?: unknown

Input data to pass to the actor.

- Defined in mod.d.ts:92

### `Optional` enabled

enabled?: boolean

Whether the actor is enabled. Defaults to true.

- Defined in mod.d.ts:97

### key

key: string | string[]

Unique key for the actor instance. This can be a string or an array of strings to create multiple instances.

#### Example

    "abc" or ["abc", "def"]

- Defined in mod.d.ts:84

### name

name: ActorName

Typesafe name of the actor. This should match the actor's name in the app's actor definitions.

#### Example

    "chatRoom"

- Defined in mod.d.ts:78

### `Optional` params

params?: Registry[ExtractActorsFromRegistry<Registry>]["params"]

Parameters for the actor.

- Defined in mod.d.ts:88