Interface PluginRuntimeApi

Readonlymanifest

emitTelemetry

• emitTelemetry(metric: string, payload: unknown): void

  Parameters

  • metric: string
  • payload: unknown

  Returns void

hasPermission

• hasPermission(
      permission:
          | "read:worldState"
          | "write:worldState"
          | "read:events"
          | "write:telemetry"
          | "write:artifacts",
  ): boolean

  Parameters

  • permission:
        | "read:worldState"
        | "write:worldState"
        | "read:events"
        | "write:telemetry"
        | "write:artifacts"

  Returns boolean

mutateWorld

• mutateWorld<T>(worldState: T, mutator: (draft: T) => void): void

  Type Parameters

  • T

  Parameters

  • worldState: T
  • mutator: (draft: T) => void

  Returns void

readWorldState

• readWorldState<T>(value: T): Readonly<T>

  Type Parameters

  • T

  Parameters

  • value: T

  Returns Readonly<T>

writeArtifact

• writeArtifact(path: string, contents: string): void

  Parameters

  • path: string
  • contents: string

  Returns void