Zola
Developer reference: this page includes exported implementation details. BUILD authors should prefer the User API reference.
ZOLA_TOOL
const ZOLA_TOOL
Undocumented.
zolaArtifactName()
zolaArtifactName(version, plat)
Return the zola release artifact filename for a version and platform.
| Parameter | Type | Description |
|---|---|---|
| version | string | |
| plat | { os: string, arch: string } |
Returns: string
zolaDownloadUrl()
zolaDownloadUrl(version, plat)
Return the zola release download URL for a version and platform.
| Parameter | Type | Description |
|---|---|---|
| version | string | |
| plat | { os: string, arch: string } |
Returns: string
zolaSupportedPlatforms()
zolaSupportedPlatforms()
Return the platforms zola publishes release archives for, derived from the module's TARGET_TRIPLES map (keyed "os-arch").
Returns: Array<{ os: string, arch: string }>
zolaCacheKey()
zolaCacheKey(version, plat)
Return the named-cache key for a zola toolchain version and platform.
| Parameter | Type | Description |
|---|---|---|
| version | string | |
| plat | { os: string, arch: string } |
Returns: string
ZolaToolchain (implementation class)
class ZolaToolchain
Implementation class. BUILD files should use zolaToolchain().
Undocumented.
zolaToolchain()
zolaToolchain(version, opts = {})
Declare a zola toolchain version and optionally set it as the default. matching lockfile entry (warns instead of failing).
| Parameter | Type | Description |
|---|---|---|
| version | string | |
| [opts] | object | |
| [opts.default=false] | boolean | |
| [opts.unverified=false] | boolean | Allow downloading without a |
Returns: object Target handle for this zola toolchain.
installZolaToolchain()
installZolaToolchain(version, source)
Install a local zola toolchain directory into the named cache.
| Parameter | Type | Description |
|---|---|---|
| version | string | |
| source | string | Path to the toolchain root. |
Returns: string|null Local path to the cached toolchain root.
acquireZolaToolchain
const acquireZolaToolchain
Acquire a zola toolchain, downloading and caching it if not already installed in the named cache.
| Parameter | Type | Description |
|---|---|---|
| version | string |
Returns: Promise<string> Local path to the toolchain root.
resolveZolaToolchainVersion()
resolveZolaToolchainVersion(version)
Resolve an explicit or default zola toolchain version.
| Parameter | Type | Description |
|---|---|---|
| [version] | string |
Returns: string|null
defaultZolaToolchainVersion()
defaultZolaToolchainVersion()
Return the currently configured default zola toolchain version.
Returns: string|null
defaultZolaToolchain()
defaultZolaToolchain()
Return the currently configured default zola toolchain target handle.
Returns: object|null