Interface: ForwardedIpMiddlewareOptions

Properties

getBuyerIp

getBuyerIp: MaybeAsyncGetter

Real buyer IP from the incoming request (e.g. the cf-connecting-ip header).

---

getSecret

getSecret: MaybeAsyncGetter

Shared platform secret used to sign. Server-side only — never expose to the browser.

---

getShopSlug?

optional getShopSlug?: MaybeAsyncGetter

OPTIONAL override for the shop slug bound into the signature. Defaults to the X-Shop-Slug header the client already sends — so you normally don't pass it, and the signed slug is guaranteed to match what the backend verifies. Provide only for non-standard transports that don't set that header.

---

now?

optional now?: () => number

Clock source (unix milliseconds). Injectable for tests; defaults to Date.now.

Returns

number