@michaelmagan/dnumb 0.1.0

package/dist/query.d.cts

@@ -0,0 +1,47 @@
+import type { Bundle } from "./bundle.cjs";
+export declare const Q_VERBS: readonly ["describe", "find", "at", "within", "distance", "nearest", "facts", "color"];
+/**
+ * A verb could not answer the question as asked. The message is the whole
+ * product: it names what was wrong and the command that fixes it, because an
+ * agent that gets `no element "e99"` and no route forward will guess.
+ */
+export declare class QueryError extends Error {
+    name: string;
+}
+export interface VerbResult {
+    /** The default rendering. No trailing newline; the CLI adds exactly one. */
+    text: string;
+    /** The `--json` payload. Always an object carrying `verb`. */
+    json: unknown;
+}
+export interface QueryOptions {
+    /** `look` only: scope the digest to one element id or tag. */
+    focus?: string;
+    /** `look` only: emit the edge-cluster histogram header. */
+    edges?: boolean;
+    /**
+     * `look` only: soft target for total digest body characters -- the
+     * standing meter (`renderDigest`'s own `DEFAULT_BUDGET_CHARS`,
+     * `digest/render.ts`). Undefined here means "let the library decide", not
+     * "no budget" -- `renderDigest` supplies its own default when this is
+     * omitted, so this file must never duplicate that number.
+     */
+    budgetChars?: number;
+    /**
+     * `look` only: soft target for digest body *lines* -- the budget's
+     * original unit. Still honored when passed explicitly, but as an
+     * *additional* ceiling on top of `budgetChars`, never a replacement for it
+     * (`RenderDigestOptions.budgetLines`'s own doc comment, `digest/types.ts`).
+     */
+    budgetLines?: number;
+    /** `nearest` only: how many neighbours. */
+    k?: number;
+    /** How many rows the list verbs print. 0 means every row. */
+    limit?: number;
+    /** `color` only: per-element fact lines instead of the pair table. */
+    all?: boolean;
+}
+/** `look` — the digest, which is the format the whole package exists to print. */
+export declare function look(bundle: Bundle, options?: QueryOptions): VerbResult;
+/** Dispatches one `q` verb. Throws `QueryError` for anything the caller can fix. */
+export declare function query(bundle: Bundle, verb: string, args?: string[], options?: QueryOptions): VerbResult;

package/dist/query.d.ts

@@ -0,0 +1,47 @@
+import type { Bundle } from "./bundle.js";
+export declare const Q_VERBS: readonly ["describe", "find", "at", "within", "distance", "nearest", "facts", "color"];
+/**
+ * A verb could not answer the question as asked. The message is the whole
+ * product: it names what was wrong and the command that fixes it, because an
+ * agent that gets `no element "e99"` and no route forward will guess.
+ */
+export declare class QueryError extends Error {
+    name: string;
+}
+export interface VerbResult {
+    /** The default rendering. No trailing newline; the CLI adds exactly one. */
+    text: string;
+    /** The `--json` payload. Always an object carrying `verb`. */
+    json: unknown;
+}
+export interface QueryOptions {
+    /** `look` only: scope the digest to one element id or tag. */
+    focus?: string;
+    /** `look` only: emit the edge-cluster histogram header. */
+    edges?: boolean;
+    /**
+     * `look` only: soft target for total digest body characters -- the
+     * standing meter (`renderDigest`'s own `DEFAULT_BUDGET_CHARS`,
+     * `digest/render.ts`). Undefined here means "let the library decide", not
+     * "no budget" -- `renderDigest` supplies its own default when this is
+     * omitted, so this file must never duplicate that number.
+     */
+    budgetChars?: number;
+    /**
+     * `look` only: soft target for digest body *lines* -- the budget's
+     * original unit. Still honored when passed explicitly, but as an
+     * *additional* ceiling on top of `budgetChars`, never a replacement for it
+     * (`RenderDigestOptions.budgetLines`'s own doc comment, `digest/types.ts`).
+     */
+    budgetLines?: number;
+    /** `nearest` only: how many neighbours. */
+    k?: number;
+    /** How many rows the list verbs print. 0 means every row. */
+    limit?: number;
+    /** `color` only: per-element fact lines instead of the pair table. */
+    all?: boolean;
+}
+/** `look` — the digest, which is the format the whole package exists to print. */
+export declare function look(bundle: Bundle, options?: QueryOptions): VerbResult;
+/** Dispatches one `q` verb. Throws `QueryError` for anything the caller can fix. */
+export declare function query(bundle: Bundle, verb: string, args?: string[], options?: QueryOptions): VerbResult;