logstream-js
v0.1.1
Published
Universal client for the Logstream logging API
Readme
logstream-js
Universal JavaScript/TypeScript client for Logstream.
Install
npm install logstream-jsUsage
import { createLogger } from 'logstream-js';
const logger = createLogger({
apiKey: process.env.LOGSTREAM_API_KEY!,
});
logger.info('Server started', { port: 3000 });
logger.error('Unhandled exception', { message: err.message });Batching
const logger = createLogger({
apiKey: process.env.LOGSTREAM_API_KEY!,
batch: {
maxSize: 20, // flush after 20 logs (default)
flushInterval: 5000 // flush every 5 seconds (default)
},
});
// Manual flush (e.g. before serverless function exits)
await logger.flush();Config
| Option | Type | Default | Description |
|---|---|---|---|
| apiKey | string | — | Required. Your app's API key |
| baseUrl | string | https://logger.borgstein.io | Override for self-hosted |
| batch.maxSize | number | 20 | Flush after N queued logs |
| batch.flushInterval | number (ms) | 5000 | Flush every N milliseconds |
| onError | (err: Error) => void | silent | Called on send failure |
Log levels
debug · info · warn · error
