eve/dist/src/compiled/@workflow/world/env-config.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

/**
 * Helpers for resolving numeric runtime-tuning constants from environment
 * variables.
 *
 * Several SDK constants (timeouts, retry counts, stream buffering, …) are
 * useful to tune per-deployment, most notably to dial them down on a
 * dedicated e2e deployment so the test suite exercises edge paths (reconnects,
 * batch splitting, retries) that otherwise only trigger after long durations
 * or large payloads.
 *
 * `envNumber` reads `process.env[name]` lazily (so tests and deployments can
 * override per invocation), clamps to an optional `[min, max]` range, and
 * never throws: an env override is an escape hatch, not a hard requirement,
 * so an invalid value falls back to the constant's compiled-in default. A
 * misconfigured value warns once per process so the mistake is observable
 * without spamming logs.
 */
export interface EnvNumberOptions {
    /** Inclusive lower bound; values below are clamped up to it. Default 0. */
    min?: number;
    /** Inclusive upper bound; values above are clamped down to it. */
    max?: number;
    /** Require an integer; fractional values fall back to the default. */
    integer?: boolean;
}
/**
 * Resolve a numeric tuning constant from `process.env[name]`, falling back to
 * `fallback` when the variable is unset, empty, or invalid. Clamps to
 * `[min, max]` when provided.
 */
export declare function envNumber(name: string, fallback: number, options?: EnvNumberOptions): number;
/**
 * Resolve a boolean feature flag from `process.env[name]`.
 *
 * Matches the convention the runtime flags already use (`WORKFLOW_TURBO`,
 * `WORKFLOW_SLOT_IDENTITY`, …): unset or empty takes `fallback`, and the only
 * values that force a side are `0` / `false` and `1` / `true`
 * (case-insensitive). Anything else falls back rather than throwing (a flag is
 * an escape hatch, not a hard requirement) and warns once per process.
 */
export declare function envFlag(name: string, fallback: boolean, env?: Record<string, string | undefined>): boolean;
export declare function getMaxEventsPerRun(): number;
/**
 * Reset the warn-once cache. Test-only, exported so unit tests can exercise
 * the warning path repeatedly without sharing state across cases.
 *
 * @internal
 */
export declare function _resetEnvWarnCacheForTests(): void;
//# sourceMappingURL=env-config.d.ts.map