typescript
Version:
TypeScript is a language for application scale JavaScript development
39 lines • 1.65 kB
TypeScript
import { type ClientOptions, type ClientSocketOptions, type ClientSpawnOptions } from "../options.ts";
import { TimingCollector, type TimingInfo } from "../timing.ts";
export type { ClientOptions, ClientSocketOptions, ClientSpawnOptions };
/**
* Client handles communication with the TypeScript API server
* over STDIO (spawned process) or a Unix domain socket using JSON-RPC.
*/
export declare class Client {
private socket;
private process;
private connection;
private options;
private connected;
private timing;
constructor(options: ClientOptions);
connect(): Promise<void>;
private connectViaSpawn;
private connectViaSocket;
private registerFSCallbacks;
apiRequest<T>(method: string, params?: unknown): Promise<T>;
apiRequestBinary(method: string, params?: unknown): Promise<Uint8Array | undefined>;
/**
* Returns the timing collector that per-node materialization is reported
* into, or undefined when timing collection is disabled. The returned
* collector is the same one folded into {@link getTimingInfo}, so
* materialization totals surface alongside request timings.
*/
getTimingCollector(): TimingCollector | undefined;
/**
* Returns a combined timing snapshot: client-measured round-trip and byte
* counts folded together with the server's own per-request processing time
* (fetched via a getServerTiming request) and estimated transport overhead.
*/
getTimingInfo(): Promise<TimingInfo>;
resetTimingInfo(): Promise<void>;
private fetchServerTiming;
close(): Promise<void>;
}
//# sourceMappingURL=client.d.ts.map