OptionalclientOptionalbaseOptionalaccessOptionaldatasourceOptionalonOptionaltimeoutOptionalretryOptionalretryOptionalretryOptionalenableOptionaletagOptionalenableOptionalcircuitOptionalunsafeOptionalenableOptionallanguageOptionalcompatibilityOptionaltenantOptionaluserWho is calling, for CCP to contact: an application name, version and
contact address. Sent as X-User-Agent (in place of clientId) and at the
start of User-Agent, before the library's own identifier.
OptionalrateOptionalrequestOptionalresponseOptionalvalidateOptionalvalidateOptionalincompleteWhat pagination does when it cannot prove a walk complete (a page count
above 1000, an empty page after the first, a cursor still set at the page
limit). 'truncate', the default, returns the pages fetched so far and
logs a warning; 'throw' rejects with an EsiPaginationError carrying
the reason and the partial result. The default becomes 'throw' in a
future major. See guides/PAGINATION.md.
OptionalloggerCustom logger for this client. Falls back to the global logger, then pino.
OptionallogLog level for the default pino logger
(fatal|error|warn|info|debug|trace, or silent to turn it off).
Overrides ESI_LOG_LEVEL.
OptionalcacheWhere 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 client
does not shut it down; its owner does.
OptionalrateThe rate limiter every request draws on, in place of the one rateLimiterConfig builds.
OptionalcircuitThe circuit breaker every request goes through, in place of the one
circuitBreakerConfig builds. Supplying one turns the breaker on. The
client does not shut it down; its owner does.
OptionaldeduplicatorThe in-flight table identical GETs join. Supplying one turns
deduplication on, whatever enableRequestDeduplication says. The client
does not clear it on shutdown; its owner does.
OptionalclockWhere 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.
The ESI tenant every request names in
X-Tenant(tranquility,singularity). Unset, no header is sent and ESI serves Tranquility.