client.stats

Get server statistics

Signature

class Client {
  stats(): Promise<{ tables: number; schema: string; uptime: number }>
}

Parameters

No parameters.

Examples

import { Client } from '@blueforge/client'
const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const stats = await bf.stats()
console.log(`${stats.tables} tables`)

Throws

ApiError

NetworkError

Pitfalls

• Project-scoped — statistics reflect the connected project database only, not the platform

See also

{auto-injected}

Tested against

{auto-injected}