N

themes

namespace themes

Functions

F

disable(id: string): void

Disables a theme and removes it from the app.

F

enable(id: string): void | Promise<void>

Enables a theme and applies it.

F

get(id: string): AddonHandle | undefined

Reads one installed theme by id.

Lists every installed theme.

F

install(url: string, digest?: string): Promise<AddonHandle | undefined>

Installs a theme from its manifest URL.

F

isEnabled(id: string): boolean

Reports whether a theme is enabled.

F

reload(id: string, bundle: string, manifest: PushedManifest, bytecode?: string): Promise<ReloadResult>

Swaps a theme's files in place, keeping its enabled state.

F

toggle(id: string): void

Enables a disabled theme, or disables an enabled one.

F

uninstall(id: string): Promise<void>

Removes an installed theme.

F

update(id: string): Promise<boolean>

Checks for updates, then applies this theme's pending update.

Returns

Whether the theme now runs a newer version.

Types

The outcome of an addon reload: success, or failure carrying the recorded error.