Interface Options

packages/cacheable-request/src/types.ts:33–75

export type CacheableOptions = (Options & RequestOptions) | string | URL;

export interface Options {
	/**
	 * If the cache should be used. Setting this to `false` will completely bypass the cache for the current request.
	 * @default true
	 */
	cache?: boolean | undefined;

	/**
	 * If set to `true` once a cached resource has expired it is deleted and will have to be re-requested.
	 *
	 * If set to `false`, after a cached resource's TTL expires it is kept in the cache and will be revalidated
	 * on the next request with `If-None-Match`/`If-Modified-Since` headers.
	 * @default false
	 */
	strictTtl?: boolean | undefined;

	/**
	 * Limits TTL. The `number` represents milliseconds.
	 * @default undefined
	 */
	maxTtl?: number | undefined;

	/**
	 * When set to `true`, if the DB connection fails we will automatically fallback to a network request.
	 * DB errors will still be emitted to notify you of the problem even though the request callback may succeed.
	 * @default false
	 */
	automaticFailover?: boolean | undefined;

	/**
	 * Forces refreshing the cache. If the response could be retrieved from the cache, it will perform a
	 * new request and override the cache instead.
	 * @default false
	 */
	forceRefresh?: boolean | undefined;
	remoteAddress?: boolean | undefined;

	url?: string | undefined;

	headers?: Record<string, string | string[] | undefined>;

	body?: Buffer;
}

// biome-ignore lint/suspicious/noExplicitAny: type
export interface CacheValue extends Record<string, any> {