CompileBlueprintV1Options

Index

Properties

• additionalSteps
• corsProxy
• gitAdditionalHeadersCallback
• onBlueprintValidated
• onStepCompleted
• progress
• semaphore
• streamBundledFile

Properties

optionaladditionalSteps

additionalSteps?: any[]

Additional steps to add to the blueprint.

optionalcorsProxy

corsProxy?: string

Proxy URL to use for cross-origin requests.

For example, if corsProxy is set to "https://cors.wordpress.net/proxy.php", then the CORS requests to https://github.com/WordPress/gutenberg.git would actually be made to https://cors.wordpress.net/proxy.php?https://github.com/WordPress/gutenberg.git.

optionalgitAdditionalHeadersCallback

gitAdditionalHeadersCallback?: (url: string) => Record<string, string>

Additional headers to pass to git operations. A function that returns headers based on the URL being accessed.

---

Type declaration

• • (url: string): Record<string, string>

  • Parameters

    • url: string

    Returns Record<string, string>

optionalonBlueprintValidated

onBlueprintValidated?: (blueprint: BlueprintV1Declaration) => void

Optional callback with blueprint validation result

---

Type declaration

• • (blueprint: BlueprintV1Declaration): void

  • Parameters

    • blueprint: BlueprintV1Declaration

    Returns void

optionalonStepCompleted

onStepCompleted?: OnStepCompleted

Optional callback with step output

optionalprogress

progress?: ProgressTracker

Optional progress tracker to monitor progress

optionalsemaphore

semaphore?: default

Optional semaphore to control access to a shared resource

optionalstreamBundledFile

streamBundledFile?: StreamBundledFile

A filesystem to use for the blueprint.