ApexPainter member
ApexPainter.use
Installs one named plugin transactionally. Installation is serialized and may be asynchronous; callers must await it.
apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)Signature
(plugin: ApexifyPlugin<ApexPainter>) => Promise<ApexPainter>Parameters
Options
2 / 2 option paths
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| plugin | ||||
plugin.installConfigure the host. Returning/rejecting a Promise is fully supported by the installation lifecycle. | (host: ApexPainter) => void | Promise<void> | RequiredDefaultRequired | — | node22 · node24 · node26 |
plugin.nameStable unique name used for duplicate-install protection. | string | RequiredDefaultRequired | — | node22 · node24 · node26 |
plugin.install
RequiredConfigure the host. Returning/rejecting a Promise is fully supported by the installation lifecycle.
- Type
(host: ApexPainter) => void | Promise<void>- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
plugin.name
RequiredStable unique name used for duplicate-install protection.
- Type
string- Default
- Required
- Allowed
- —
- Runtime
- node22, node24, node26
Types
ApexifyPlugin: ApexifyPlugin<ApexPainter>
- name
string - install
(host: ApexPainter) => void | Promise<void>
Return value
Promise<ApexPainter>
The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.
Errors
NOT APPLICABLE — no verified errors are bound to this API.
Limits
NOT APPLICABLE — no API-specific verified limits are bound to this API.
Related APIs
No explicit related API metadata.