Skip to main content

StartPlaygroundOptions

Index

Properties

optionalblueprint

blueprint?: Blueprint

optionaldisableProgressBar

disableProgressBar?: boolean

iframe

iframe: HTMLIFrameElement

optionalonBeforeBlueprint

onBeforeBlueprint?: () => Promise<void>

Type declaration

    • (): Promise<void>
    • Called before the blueprint steps are run, allows the caller to delay the Blueprint execution once the Playground is booted.


      Returns Promise<void>

optionalonBlueprintStepCompleted

onBlueprintStepCompleted?: OnStepCompleted

optionalonClientConnected

onClientConnected?: (playground: PlaygroundClient) => void

Type declaration

    • Called when the playground client is connected, but before the blueprint steps are run.


      Parameters

      Returns void

optionalprogressTracker

progressTracker?: ProgressTracker

remoteUrl

remoteUrl: string

optionalsiteSlug

siteSlug?: string