@dudousxd/nestjs-telescope/dist/nest/watcher.d.ts

Laravel Telescope-style observability console for NestJS — core: watchers, recorder, correlation, SQLite store, headless API.

import type { ModuleRef } from '@nestjs/core';
import type { ResolvedCoreConfig } from '../config/options.js';
import type { BatchOrigin, RecordInput } from '../entry/entry.js';
/** Handle to an open entry-point batch. */
export interface BatchHandle {
    readonly id: string;
    /** Close the batch (ends the ALS scope if this handle opened one). */
    end(): void;
}
/** Everything a watcher is handed at registration time. */
export interface WatcherContext {
    /** Hand an entry to the Recorder — fire-and-forget, never throws/blocks. */
    record(input: RecordInput): void;
    /** Open a batch and run `fn` inside its ALS scope (entry-point watchers). */
    runInBatch<T>(origin: BatchOrigin, fn: () => Promise<T>): Promise<T>;
    /** Open a batch without a callback scope (caller must `end()` it). */
    beginBatch(origin: BatchOrigin): BatchHandle;
    readonly config: ResolvedCoreConfig;
    readonly moduleRef: ModuleRef;
}
/** A source of entries. Built-ins and community watchers implement this. */
export interface Watcher {
    /** The entry `type` this watcher produces. */
    readonly type: string;
    /** Wire framework hooks; called once during module init. */
    register(ctx: WatcherContext): void | Promise<void>;
    /** Optional cheap pre-filter before constructing an entry. */
    shouldRecord?(candidate: unknown): boolean;
}
//# sourceMappingURL=watcher.d.ts.map