RequestInitCfProperties

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7641

In addition to the properties you can set in the RequestInit dict that you pass as an argument to the Request constructor, you can set certain properties of a cf object to control how Cloudflare features are applied to that new Request.

Note: Currently, these properties cannot be tested in the playground.

Extends

Record<string, unknown>

Indexable

[key: string]: unknown

Properties

apps?

optional apps: boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7671

cacheEverything?

optional cacheEverything: boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7642

cacheKey?

optional cacheKey: string

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7651

A request’s cache key is what determines if two requests are “the same” for caching purposes. If a request has the same cache key as some previous request, then we can serve the same cached response for both. (e.g. ‘some-key’)

Only available for Enterprise customers.

cacheTags?

optional cacheTags: string[]

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7660

This allows you to append additional Cache-Tag response headers to the origin response without modifications to the origin server. This will allow for greater control over the Purge by Cache Tag feature utilizing changes only in the Workers process.

Only available for Enterprise customers.

cacheTtl?

optional cacheTtl: number

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7664

Force response to be cached for a given number of seconds. (e.g. 300)

cacheTtlByStatus?

optional cacheTtlByStatus: Record<string, number>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7669

Force response to be cached for a given number of seconds based on the Origin status code. (e.g. { ‘200-299’: 86400, ‘404’: 1, ‘500-599’: 0 })

image?

optional image: RequestInitCfPropertiesImage

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7672

minify?

optional minify: RequestInitCfPropertiesImageMinify

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7673

mirage?

optional mirage: boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7674

polish?

optional polish: "off" | "lossy" | "lossless"

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7675

r2?

optional r2: RequestInitCfPropertiesR2

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7676

resolveOverride?

optional resolveOverride: string

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7690

Redirects the request to an alternate origin server. You can use this, for example, to implement load balancing across several origins. (e.g.us-east.example.com)

Note - For security reasons, the hostname set in resolveOverride must be proxied on the same Cloudflare zone of the incoming request. Otherwise, the setting is ignored. CNAME hosts are allowed, so to resolve to a host under a different domain or a DNS only domain first declare a CNAME record within your own zone’s DNS mapping to the external hostname, set proxy on Cloudflare, then set resolveOverride to point to that CNAME record.

scrapeShield?

optional scrapeShield: boolean

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:7670