# Interface RunnerConfig

interface RunnerConfig {
endpoint: string;
fetch: (
runner: Runner,
actorId: string,
requestId: ArrayBuffer,
request: Request,
) => Promise<Response>;
getActorHibernationConfig: (
actorId: string,
requestId: ArrayBuffer,
request: Request,
) => HibernationConfig;
logger?: Logger;
metadata?: Record<string, any>;
namespace: string;
noAutoShutdown?: boolean;
onActorStart: (
actorId: string,
generation: number,
config: ActorConfig,
) => Promise<void>;
onActorStop: (actorId: string, generation: number) => Promise<void>;
onConnected: () => void;
onDisconnected: (code: number, reason: string) => void;
onShutdown: () => void;
pegboardEndpoint?: string;
pegboardRelayEndpoint?: string;
prepopulateActorNames: Record<string, { metadata: Record<string, any> }>;
runnerKey: string;
runnerName: string;
token?: string;
totalSlots: number;
version: number;
websocket?: (
runner: Runner,
actorId: string,
ws: any,
requestId: ArrayBuffer,
request: Request,
) => Promise<void>;
}

- Defined in mod.ts:38

##### Index

### Properties

endpoint
fetch
getActorHibernationConfig
logger?
metadata?
namespace
noAutoShutdown?
onActorStart
onActorStop
onConnected
onDisconnected
onShutdown
pegboardEndpoint?
pegboardRelayEndpoint?
prepopulateActorNames
runnerKey
runnerName
token?
totalSlots
version
websocket?

## Properties

### endpoint

endpoint: string

- Defined in mod.ts:41

### fetch

fetch: (
runner: Runner,
actorId: string,
requestId: ArrayBuffer,
request: Request,
) => Promise<Response>

- Defined in mod.ts:54

### getActorHibernationConfig

getActorHibernationConfig: (
actorId: string,
requestId: ArrayBuffer,
request: Request,
) => HibernationConfig

- Defined in mod.ts:73

### `Optional` logger

logger?: Logger

- Defined in mod.ts:39

### `Optional` metadata

metadata?: Record<string, any>

- Defined in mod.ts:50

### namespace

namespace: string

- Defined in mod.ts:45

### `Optional` noAutoShutdown

noAutoShutdown?: boolean

- Defined in mod.ts:78

### onActorStart

onActorStart: (
actorId: string,
generation: number,
config: ActorConfig,
) => Promise<void>

- Defined in mod.ts:67

### onActorStop

onActorStop: (actorId: string, generation: number) => Promise<void>

- Defined in mod.ts:72

### onConnected

onConnected: () => void

- Defined in mod.ts:51

### onDisconnected

onDisconnected: (code: number, reason: string) => void

- Defined in mod.ts:52

### onShutdown

onShutdown: () => void

- Defined in mod.ts:53

### `Optional` pegboardEndpoint

pegboardEndpoint?: string

- Defined in mod.ts:43

### `Optional` pegboardRelayEndpoint

pegboardRelayEndpoint?: string

- Defined in mod.ts:44

### prepopulateActorNames

prepopulateActorNames: Record<string, { metadata: Record<string, any> }>

- Defined in mod.ts:49

### runnerKey

runnerKey: string

- Defined in mod.ts:48

### runnerName

runnerName: string

- Defined in mod.ts:47

### `Optional` token

token?: string

- Defined in mod.ts:42

### totalSlots

totalSlots: number

- Defined in mod.ts:46

### version

version: number

- Defined in mod.ts:40

### `Optional` websocket

websocket?: (
runner: Runner,
actorId: string,
ws: any,
requestId: ArrayBuffer,
request: Request,
) => Promise<void>

- Defined in mod.ts:60