JSDoc

Minimal API client for the core module.

class CoreClient

options: ClientOptions

constructor(options: ClientOptions): CoreClient

<T>(input: RequestInput): Promise<RequestResult<T>>

Create a new client instance.

createCoreClient(options: ClientOptions): CoreClient

Convenience greeting for quick smoke testing.

helloCore(name: string, excited?: boolean): string

Supported HTTP methods for client requests.

type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

Configuration for creating a Core client.

type ClientOptions = {
  /**
   * Base URL for API requests (for example, "https://api.example.com").
   */
  baseUrl: string;
  /**
   * Optional API key for authenticated requests.
   */
  apiKey?: string;
  /**
   * Request timeout in milliseconds.
   */
  timeoutMs?: number;
}

Input shape for a request.

type RequestInput = {
  /**
   * Path to append to the base URL (for example, "/v1/health").
   */
  path: string;
  /**
   * HTTP method to use.
   */
  method?: HttpMethod;
  /**
   * Optional JSON-serializable body.
   */
  body?: unknown;
}

Result of a request.

type RequestResult = RequestResult<T>

const moduleId: "core"