Config: {
    username: string;
    password: string;
    apiKey: string;
    graphic?: string;
    logging?: {
        level: "info" | "error" | "warn" | "debug" | "verbose";
        color: boolean;
    };
    getToken?: (() => Promise<string>);
}

ServerClient config passed to ServerClient.constructor

Type declaration

  • username: string

    Lynx username

  • password: string

    Lynx password

  • apiKey: string

    Sphinx API key

  • Optional graphic?: string

    RNGS graphic ID (UUID)

  • Optional logging?: {
        level: "info" | "error" | "warn" | "debug" | "verbose";
        color: boolean;
    }
    • level: "info" | "error" | "warn" | "debug" | "verbose"
    • color: boolean
  • Optional getToken?: (() => Promise<string>)
      • (): Promise<string>
      • Bring your own functon to get a token for the graphics server.

        Used to override the prompt dialogue in other tools like the graphics kit publisher.

        Returns Promise<string>

        Sphinx API token

Generated using TypeDoc