Function createClient

Parameters

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

    • OptionaldisableMetadataLookup?: boolean

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

    • Optionalencoding?: "json" | "cbor" | "bare"

    • Optionalendpoint?: string

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

    • OptionalgetUpgradeWebSocket?: GetUpgradeWebSocket

    • Optionalheaders?: Record<string, string>

    • Optionalnamespace?: string

      Namespace to connect to.

    • OptionalrunnerName?: 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.