GetDesignOptions
GetDesignOptions =
object
Defined in: packages/sdk/src/index.ts:20
Properties
Section titled “Properties”credentials?
Section titled “credentials?”
optionalcredentials?:GetDesignCredentials
Defined in: packages/sdk/src/index.ts:24
Request-scoped credentials for BYOK runs.
installI18nFonts?
Section titled “installI18nFonts?”
optionalinstallI18nFonts?:boolean
Defined in: packages/sdk/src/index.ts:28
Force or skip i18n font install. Auto-detected from URL TLD when omitted.
measurementMode?
Section titled “measurementMode?”
optionalmeasurementMode?:"cdp"|"visual"|"auto"
Defined in: packages/sdk/src/index.ts:30
Override measurement strategy. auto tries CDP first, then visual-stability.
runDesign?
Section titled “runDesign?”
optionalrunDesign?: (url,options?) =>Promise<RunDesignResult>
Defined in: packages/sdk/src/index.ts:35
Internal/testing seam. Defaults to the real local agent pipeline. Most callers should not pass this.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”RunDesignOptions
Returns
Section titled “Returns”Promise<RunDesignResult>
siteName?
Section titled “siteName?”
optionalsiteName?:string
Defined in: packages/sdk/src/index.ts:22
Override the detected site name.
visualRequirement?
Section titled “visualRequirement?”
optionalvisualRequirement?:VisualRequirement
Defined in: packages/sdk/src/index.ts:26
Continue with text-only output if visual capture is unavailable.