@rljson/edge 0.0.0 → 0.0.1

package/dist/edge.d.ts

@@ -1,4 +1,62 @@
+import { ECarWorld } from './car-world/car-world.ts';
+import { EConfig, EResolvedConfig } from './config/config.ts';
+import { EPresetName } from './config/presets.ts';
+import { EEstimate } from './core/estimate.ts';
+import { ESink } from './core/sink.ts';
+/** What a run produced */
+export interface EStats extends EEstimate {
+    /** How long the run took, in milliseconds */
+    durationMs: number;
+    /** The share of produced rows that equalled an earlier row and were dropped */
+    dedupRatio: number;
+}
+/**
+ * Edge, the example data generator for Rljson.
+ *
+ * Edge builds a car world: manufacturers with catalogs of cars, and for every
+ * car a price, a brand, a workshop, a bill of materials and a CAD scene. The
+ * world uses components, slice ids, layers, cakes, trees, revisions and table
+ * configurations. Nothing is random: the same configuration yields the same
+ * data and the same hashes, everywhere.
+ */
 export declare class Edge {
-    /** Example instance for test purposes */
+    /**
+     * Constructor
+     * @param config - The configuration; every field has a default
+     */
+    constructor(config?: EConfig);
+    /**
+     * Creates a generator from a preset.
+     * @param name - tiny, small, medium, large or xl
+     * @param overrides - Settings that replace parts of the preset
+     */
+    static preset(name: EPresetName, overrides?: EConfig): Edge;
+    /** Returns an example instance for test purposes: the tiny preset */
     static get example(): Edge;
+    /** Calculates how big the world will be, without generating a row */
+    estimate(): EEstimate;
+    /**
+     * Generates the world in memory and returns it with the statistics of the
+     * run. This is the default way to use Edge and fits worlds up to the medium
+     * preset.
+     */
+    generate(): Promise<{
+        world: ECarWorld;
+        stats: EStats;
+    }>;
+    /**
+     * Generates the world and hands every row to a sink, in the order of the
+     * references. Nothing is kept. Without a sink the rows are dropped, which
+     * serves benchmarks and progress tests.
+     * @param sink - Receives the rows
+     */
+    run(sink?: ESink): Promise<EStats>;
+    /** The configuration with every default filled in */
+    readonly config: EResolvedConfig;
 }
+/**
+ * Merges overrides into a configuration, section by section.
+ * @param base - The configuration to start from
+ * @param overrides - The settings that replace parts of it
+ */
+export declare const mergeConfigs: (base: EConfig, overrides: EConfig) => EConfig;