GetDesignOptions

GetDesignOptions = object

Defined in: packages/sdk/src/index.ts:23

Properties

credentials?

optional credentials?: GetDesignCredentials

Defined in: packages/sdk/src/index.ts:27

Request-scoped credentials for BYOK runs.

---

installI18nFonts?

optional installI18nFonts?: boolean

Defined in: packages/sdk/src/index.ts:31

Force or skip i18n font install. Auto-detected from URL TLD when omitted.

---

measurementMode?

optional measurementMode?: "cdp" | "visual" | "auto"

Defined in: packages/sdk/src/index.ts:33

Override measurement strategy. auto tries CDP first, then visual-stability.

---

runDesign?

optional runDesign?: (url, options?) => Promise<RunDesignResult>

Defined in: packages/sdk/src/index.ts:38

Internal/testing seam. Defaults to the real local agent pipeline. Most callers should not pass this.

Parameters

url

string

options?

RunDesignOptions

Returns

Promise<RunDesignResult>

---

siteName?

optional siteName?: string

Defined in: packages/sdk/src/index.ts:25

Override the detected site name.

---

visualRequirement?

optional visualRequirement?: VisualRequirement

Defined in: packages/sdk/src/index.ts:29

Explicitly select text-only output; the default requires screenshots.