Interface EsiOptions

Who is calling, for CCP to contact: an application name, version and a contact address, such as fleet-tool/2.1 (ops@example.com). Sent as X-User-Agent and at the start of User-Agent. Required: the runtime refuses to construct without one.

Defaults to https://esi.evetech.net. Another host needs unsafeAllowCustomHost.

The ESI tenant every request names in X-Tenant; unset, ESI serves Tranquility.

Sends each HTTP request. Defaults to globalThis.fetch.

Set true to check each response against the operation's Zod schema, generated from the OpenAPI document, and throw EsiValidationError on a mismatch. Unset or false, the generated operations return bodies as ESI sent them, as they always have. A future major release will make validation the default for createEsi; set false to keep bodies unvalidated then.

What pagination does when it cannot prove a walk complete (a page count above 1000, an empty page after the first). 'truncate', the default, yields the pages fetched so far and logs a warning; 'throw' rejects with an EsiPaginationError carrying the reason. The default becomes 'throw' in a future major. See guides/PAGINATION.md.

Where the pipeline logs. Defaults to the package's pino logger at logLevel.

Where the conditional-request cache keeps bodies and ETags, in place of the in-memory cache etagCacheConfig configures: a shared store (Redis, a file) implementing the CacheStore port, or an ICache such as an ETagCacheManager. Ignored when enableETagCache is false. The runtime does not shut it down; its owner does.

The rate limiter every view draws on, in place of the one rateLimiterConfig builds.

The circuit breaker every view goes through, in place of the one circuitBreakerConfig builds. Supplying one turns the breaker on. The runtime does not shut it down; its owner does.

The in-flight table identical GETs join. Supplying one turns deduplication on.

Where the pipeline reads time and waits: cache entry age, retry back-off, the rate limiter's windows and waits, the circuit breaker's reset timeout and response times. Defaults to the wall clock and real timers. The cleanup timers and the request timeout always run on real time, and a supplied middleware instance keeps whatever clock it was built with.