Skip to content

hailer.app

Operations on the running app itself: its config and its marketplace product.

hailer.app.config

MethodHost opReturns
update(config, option?)app.config.updatePromise<void>
ts
await hailer.app.config.update({ apiBase: 'https://example.com' });

Updates the app's config values. Only keys declared in the app manifest's config.fields are accepted, and each value is a string of at most 4096 characters. option.appId defaults to the running app; a workspace app can only update its own config.

The current config is delivered through the config callback on init and whenever it changes.

hailer.app.product

Marketplace lookups for the running app.

MethodHost opReturns
isProductInstalled(productId, workspaceId)app.product.isProductInstalledPromise<boolean>
get(id)app.product.getPromise<ProductVersion | undefined>
install(productId, workspaceId)app.product.installPromise<boolean>
getInstalledVersion(id)app.product.getInstalledVersionPromise<Version>
getManifest(id)app.product.getManifestPromise<any>
ts
const installed = await hailer.app.product.isProductInstalled(productId, workspaceId);
const version = await hailer.app.product.getInstalledVersion(productId);

See ProductVersion / Version. For managing your own products, see hailer.product.

Hailer Developer Documentation