# Class Runner

- Defined in mod.ts:100

##### Index

### Constructors

constructor

### Properties

runnerId?

### Accessors

config
log
pegboardEndpoint
pegboardUrl

### Methods

__sendToServer
__webSocketReady
clearAlarm
forceStopActor
getActor
getServerlessInitPacket
hasActor
kvDelete
kvDrop
kvGet
kvListAll
kvListPrefix
kvListRange
kvPut
sendWebsocketMessageAck
setAlarm
shutdown
sleepActor
start
stopActor

## Constructors

### constructor

- new Runner(config: RunnerConfig): Runner

  #### Parameters

  - config: RunnerConfig

  #### Returns Runner

  - Defined in mod.ts:164

## Properties

### `Optional` runnerId

runnerId?: string

- Defined in mod.ts:112

## Accessors

### config

- get config(): RunnerConfig

  #### Returns RunnerConfig

  - Defined in mod.ts:103

### log

- get log(): Logger | undefined

  #### Returns Logger | undefined

  - Defined in mod.ts:143

### pegboardEndpoint

- get pegboardEndpoint(): string

  #### Returns string

  - Defined in mod.ts:478

### pegboardUrl

- get pegboardUrl(): string

  #### Returns string

  - Defined in mod.ts:481

## Methods

### __sendToServer

- __sendToServer(message: ToServer): void

  #### Parameters

  - message: ToServer

  #### Returns void

  - Defined in mod.ts:1409

### __webSocketReady

- __webSocketReady(): boolean

  #### Returns boolean

  - Defined in mod.ts:1403

### clearAlarm

- clearAlarm(actorId: string, generation?: number): void

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns void

  - Defined in mod.ts:1319

### forceStopActor

- forceStopActor(actorId: string, generation?: number): Promise<void>

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns Promise<void>

  - Defined in mod.ts:203

### getActor

- getActor(actorId: string, generation?: number): ActorInstance | undefined

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns ActorInstance | undefined

  - Defined in mod.ts:235

### getServerlessInitPacket

- getServerlessInitPacket(): string | undefined

  #### Returns string | undefined

  - Defined in mod.ts:1434

### hasActor

- hasActor(actorId: string, generation?: number): boolean

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns boolean

  - Defined in mod.ts:256

### kvDelete

- kvDelete(actorId: string, keys: Uint8Array<ArrayBufferLike>[]): Promise<void>

  #### Parameters

  - actorId: string
  - keys: Uint8Array<ArrayBufferLike>[]

  #### Returns Promise<void>

  - Defined in mod.ts:1260

### kvDrop

- kvDrop(actorId: string): Promise<void>

  #### Parameters

  - actorId: string

  #### Returns Promise<void>

  - Defined in mod.ts:1277

### kvGet

- kvGet(
  actorId: string,
  keys: Uint8Array<ArrayBufferLike>[],
  ): Promise<(Uint8Array<ArrayBufferLike> | null)[]>

  #### Parameters

  - actorId: string
  - keys: Uint8Array<ArrayBufferLike>[]

  #### Returns Promise<(Uint8Array<ArrayBufferLike> | null)[]>

  - Defined in mod.ts:1130

### kvListAll

- kvListAll(
  actorId: string,
  options?: KvListOptions,
  ): Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  #### Parameters

  - actorId: string
  - `Optional` options: KvListOptions

  #### Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  - Defined in mod.ts:1151

### kvListPrefix

- kvListPrefix(
  actorId: string,
  prefix: Uint8Array,
  options?: KvListOptions,
  ): Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  #### Parameters

  - actorId: string
  - prefix: Uint8Array
  - `Optional` options: KvListOptions

  #### Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  - Defined in mod.ts:1206

### kvListRange

- kvListRange(
  actorId: string,
  start: Uint8Array,
  end: Uint8Array,
  exclusive?: boolean,
  options?: KvListOptions,
  ): Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  #### Parameters

  - actorId: string
  - start: Uint8Array
  - end: Uint8Array
  - `Optional` exclusive: boolean
  - `Optional` options: KvListOptions

  #### Returns Promise<[Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]>

  - Defined in mod.ts:1169

### kvPut

- kvPut(
  actorId: string,
  entries: [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][],
  ): Promise<void>

  #### Parameters

  - actorId: string
  - entries: [Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>][]

  #### Returns Promise<void>

  - Defined in mod.ts:1233

### sendWebsocketMessageAck

- sendWebsocketMessageAck(requestId: ArrayBuffer, index: number): void

  #### Parameters

  - requestId: ArrayBuffer
  - index: number

  #### Returns void

  - Defined in mod.ts:1430

### setAlarm

- setAlarm(actorId: string, alarmTs: number | null, generation?: number): void

  #### Parameters

  - actorId: string
  - alarmTs: number | null
  - `Optional` generation: number

  #### Returns void

  - Defined in mod.ts:1287

### shutdown

- shutdown(immediate: boolean, exit?: boolean): Promise<void>

  #### Parameters

  - immediate: boolean
  - exit: boolean = false

  #### Returns Promise<void>

  - Defined in mod.ts:343

### sleepActor

- sleepActor(actorId: string, generation?: number): void

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns void

  - Defined in mod.ts:175

### start

- start(): Promise<void>

  #### Returns Promise<void>

  - Defined in mod.ts:293

### stopActor

- stopActor(actorId: string, generation?: number): Promise<void>

  #### Parameters

  - actorId: string
  - `Optional` generation: number

  #### Returns Promise<void>

  - Defined in mod.ts:193