Classes

ObsClient

ObsClient - TypeScript SDK for Epic Flow Observability Platform

Features:

• REST API resources for errors, logs, sessions, and projects
• Real-time event streaming via Server-Sent Events (SSE)
• Type-safe async iterators for streaming data
• Automatic reconnection with exponential backoff

Constructor

constructor(config: ObsClientConfig)

Parameters:

Properties

Examples:

const client = new ObsClient({
  serverUrl: 'http://localhost:3010',
  apiKey: 'your-api-key'
});

// REST API usage
const errors = await client.errors.list({ projectId: 'my-app' });

// Streaming usage
for await (const error of client.stream.errors('my-app')) {
  console.log('Real-time error:', error.message);
}

HttpClient

Constructor

constructor(config: ObsClientConfig)

Parameters:

Methods

get

get(path: string, options?: { params?: Record<string, unknown>; } | undefined): Promise<T>

Parameters:

Returns:

Promise<T> -

post

post(path: string, body?: unknown): Promise<T>

Parameters:

Returns:

Promise<T> -

put

put(path: string, body?: unknown): Promise<T>

Parameters:

Returns:

Promise<T> -

delete

delete(path: string): Promise<T>

Parameters:

Returns:

Promise<T> -

request

request(config: RequestConfig): Promise<T>

Parameters:

Returns:

Promise<T> -

SSEClient

SSE Client for handling Server-Sent Events connections

Features:

• Async iterator interface for streaming events
• Automatic reconnection with exponential backoff
• Event parsing and type safety
• Graceful connection cleanup

Constructor

constructor(config: ObsClientConfig)

Parameters:

Methods

connect

Connect to SSE endpoint and return async iterable

connect(endpoint: string, options: SSEConnectionOptions): AsyncIterableIterator<SSEEvent>

Parameters:

Returns:

AsyncIterableIterator<SSEEvent> -

resetReconnection

Reset reconnection state (useful for manual reconnection)

resetReconnection(): void

ErrorsResource

Constructor

constructor(http: HttpClient)

Parameters:

Methods

list

list(filters: ErrorFilters): Promise<ErrorListResponse>

Parameters:

Returns:

Promise<ErrorListResponse> -

get

get(id: string): Promise<ErrorEvent>

Parameters:

Returns:

Promise<ErrorEvent> -

stats

stats(projectId: string, options?: StatsOptions | undefined): Promise<ErrorStats>

Parameters:

Returns:

Promise<ErrorStats> -

LogsResource

Constructor

constructor(http: HttpClient)

Parameters:

Methods

list

list(filters: LogFilters): Promise<LogListResponse>

Parameters:

Returns:

Promise<LogListResponse> -

get

get(id: string): Promise<LogEvent>

Parameters:

Returns:

Promise<LogEvent> -

create

create(input: CreateLogInput): Promise<LogEvent>

Parameters:

Returns:

Promise<LogEvent> -

ProjectsResource

Constructor

constructor(http: HttpClient)

Parameters:

Methods

create

create(input: CreateProjectInput): Promise<Project>

Parameters:

Returns:

Promise<Project> -

list

list(): Promise<Project[]>

Returns:

Promise<Project[]> -

get

get(id: string): Promise<Project>

Parameters:

Returns:

Promise<Project> -

update

update(id: string, input: UpdateProjectInput): Promise<Project>

Parameters:

Returns:

Promise<Project> -

delete

delete(id: string): Promise<{ success: boolean; }>

Parameters:

Returns:

Promise<{ success: boolean; }> -

stats

stats(id: string, options?: StatsOptions | undefined): Promise<ProjectStats>

Parameters:

Returns:

Promise<ProjectStats> -

SessionsResource

Constructor

constructor(http: HttpClient)

Parameters:

Methods

list

list(filters: SessionFilters): Promise<SessionListResponse>

Parameters:

Returns:

Promise<SessionListResponse> -

get

get(id: string): Promise<Session>

Parameters:

Returns:

Promise<Session> -

getBreadcrumbs

getBreadcrumbs(id: string): Promise<Breadcrumb[]>

Parameters:

Returns:

Promise<Breadcrumb[]> -

StreamResource

StreamResource - Handle real-time event streaming via SSE

Provides async iterators for streaming errors, logs, and sessions in real-time.

Constructor

constructor(sseClient: SSEClient)

Parameters:

Methods

tail

Tail all events from a project

tail(options: StreamOptions): AsyncIterableIterator<ObsEvent>

Parameters:

Returns:

AsyncIterableIterator<ObsEvent> - Async iterator of observability events

Examples:

for await (const event of client.stream.tail({ projectId: 'my-app', eventTypes: ['error'] })) {
  if (event.type === 'error') {
    console.log('Error:', event.message);
  }
}

errors

Stream only error events

errors(projectId: string, options?: Omit<StreamOptions, "projectId" | "eventTypes"> | undefined): AsyncIterableIterator<ErrorEvent>

Parameters:

Returns:

AsyncIterableIterator<ErrorEvent> - Async iterator of error events

Examples:

for await (const error of client.stream.errors('my-app', { level: 'fatal' })) {
  console.log('Fatal error:', error.message);
}

logs

Stream only log events

logs(projectId: string, options?: Omit<StreamOptions, "projectId" | "eventTypes"> | undefined): AsyncIterableIterator<LogEvent>

Parameters:

Returns:

AsyncIterableIterator<LogEvent> - Async iterator of log events

Examples:

for await (const log of client.stream.logs('my-app', { level: 'error' })) {
  console.log('Log:', log.message);
}

sessions

Stream only session events

sessions(projectId: string, options?: Omit<StreamOptions, "projectId" | "eventTypes"> | undefined): AsyncIterableIterator<Session>

Parameters:

Returns:

AsyncIterableIterator<Session> - Async iterator of session events

Examples:

for await (const session of client.stream.sessions('my-app')) {
  console.log('Session:', session.id);
}

Examples:

const client = new ObsClient({ ... });

// Stream all events
for await (const event of client.stream.tail({ projectId: 'my-app' })) {
  console.log('Event:', event);
}

// Stream only errors
for await (const error of client.stream.errors('my-app')) {
  console.log('Error:', error.message);
}

ObsError

Constructor

constructor(message: string)

Parameters:

AuthError

Constructor

constructor(message: string)

Parameters:

NotFoundError

Constructor

constructor(message: string)

Parameters:

RateLimitError

Constructor

constructor(message: string)

Parameters:

ApiError

Constructor

constructor(message: string)

Parameters: