eve
Version:
Filesystem-first framework for durable backend AI agents that run anywhere.
39 lines • 1.73 kB
TypeScript
/**
* 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;
/**
* 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