Client API — eyeball docs

Construct the TypeScript client and access its typed service namespaces.

`Eyeball`

Authenticated TypeScript entry point for every Eyeball SDK namespace.

Constructor

constructor(options: EyeballOptions): Eyeball

Parameter	Type	Required	Description
`options`	`EyeballOptions`	Yes	Project credential, executor URL, user binding, and optional test seams.

Returns: Eyeball

Properties

Property	Type	Required	Readonly	Description
`connections`	`ConnectionsClient`	Yes	Yes	Development connection fixture administration.
`executions`	`ExecutionsClient`	Yes	Yes	Execution history and terminal-state polling.
`files`	`FilesClient`	Yes	Yes	Project-scoped staged file operations.
`subscriptions`	`SubscriptionsClient`	Yes	Yes	User-scoped trigger subscription operations.
`tools`	`ToolsClient`	Yes	Yes	Local discovery and canonical tool execution.
`triggerEvents`	`TriggerEventsClient`	Yes	Yes	Redacted project trigger-arrival history.
`triggers`	`TriggersClient`	Yes	Yes	Local canonical trigger discovery.
`webhooks`	`WebhooksClient`	Yes	Yes	Signed webhook endpoint and delivery operations.

`VERSION`

Installed SDK source version.

const VERSION: "0.2.0"

Types

`EyeballOptions`

Authentication, executor location, user binding, and transport seams.

export interface EyeballOptions {
  apiKey: string;
  baseUrl: string;
  fetch?: typeof globalThis.fetch;
  /** Default end-user binding for user-scoped methods. */
  userId?: string;
  /** Test seam used by execution polling. */
  clock?: EyeballClock;
  /** Test seam used by execution polling. */
  sleep?: EyeballSleep;
  /** Development-only escape hatch for non-loopback cleartext executor URLs. */
  allowInsecureHttp?: boolean;
}

Property	Type	Required	Readonly	Description
`allowInsecureHttp`	`boolean`	No	No	Development-only escape hatch for non-loopback cleartext executor URLs.
`apiKey`	`string`	Yes	No	—
`baseUrl`	`string`	Yes	No	—
`clock`	`EyeballClock`	No	No	Test seam used by execution polling.
`fetch`	`(input: string \| URL \| Request, init?: RequestInit) => Promise<Response>`	No	No	—
`sleep`	`EyeballSleep`	No	No	Test seam used by execution polling.
`userId`	`string`	No	No	Default end-user binding for user-scoped methods.

`EyeballClock`

Injectable millisecond clock used to bound execution polling.

export interface EyeballClock {
  now(): number;
}

Property	Type	Required	Readonly	Description
`now`	`() => number`	Yes	No	—

`EyeballSleep`

Injectable sleep function used by polling and safe GET retry delays.

export type EyeballSleep = (milliseconds: number) => Promise<void>;

`JsonValue`

export type JsonValue =
  | JsonPrimitive
  | readonly JsonValue[]
  | { readonly [key: string]: JsonValue };