Function createClientWithDriver

Parameters

• driver: ManagerDriver
• config: {
      disableMetadataLookup: boolean;
      encoding: "json" | "cbor" | "bare";
      endpoint?: string;
      getUpgradeWebSocket?: GetUpgradeWebSocket;
      headers: Record<string, string>;
      namespace: string;
      runnerName: string;
      token?: string;
  }

  • disableMetadataLookup: boolean

    Whether to automatically perform health checks when the client is created.

  • encoding: "json" | "cbor" | "bare"

  • Optionalendpoint?: string

    Endpoint to connect to for Rivet Engine or RivetKit manager API.

  • OptionalgetUpgradeWebSocket?: GetUpgradeWebSocket

  • headers: Record<string, string>

  • namespace: string

    Namespace to connect to.

  • runnerName: string

    Name of the runner. This is used to group together runners in to different pools.

  • Optionaltoken?: string

    Token to use to authenticate with the API.