APEXIFY.JS / ENGINE REFERENCE
Build with precision.
From the first canvas to a complete rendering pipeline. Browse the exports and documented contracts published by apexify.js@6.0.0.
Generated from the actual package at commit b6ca97cfc675. Use the linked signatures, parameters, limitations and examples to build against the real engine.
Explore the API
232 matching exports · Source-generated, versioned
ADSR envelope (seconds + sustain level 0–1). Stages are proportionally fitted when A+D+R exceeds the layer duration.
type · CURRENT · node22, node24, node26AlignModePublished type export AlignMode.
class · CURRENT · node22, node24, node26ApexifyAssetErrorPublished class export ApexifyAssetError.
class · CURRENT · node22, node24, node26ApexifyConfigErrorPublished class export ApexifyConfigError.
class · CURRENT · node22, node24, node26ApexifyDecodeErrorPublished class export ApexifyDecodeError.
class · CURRENT · node22, node24, node26ApexifyErrorPublished class export ApexifyError.
class · CURRENT · node22, node24, node26ApexifyExternalServiceErrorPublished class export ApexifyExternalServiceError.
class · CURRENT · node22, node24, node26ApexifyInputErrorPublished class export ApexifyInputError.
interface · CURRENT · node22, node24, node26ApexifyPluginInstall hook for optional features without growing the core {@link ApexPainter } class. Installation may be synchronous or asynchronous. `ApexPainter.use(plugin)` always returns a Promise and must be awaited before plugin APIs are considered installed. Plugin names are unique per painter. Registrations made through `painter.plugins` during a failed installation are rolled back.
class · CURRENT · node22, node24, node26ApexifyPluginErrorPublished class export ApexifyPluginError.
class · CURRENT · node22, node24, node26ApexifyProcessErrorPublished class export ApexifyProcessError.
class · CURRENT · node22, node24, node26ApexifyRemoteFetchErrorPublished class export ApexifyRemoteFetchError.
class · CURRENT · node22, node24, node26ApexifyResourceLimitErrorPublished class export ApexifyResourceLimitError.
interface · CURRENT · node22, node24, node26ApexifyRuntimeConfigPublished interface export ApexifyRuntimeConfig.
type · CURRENT · node22, node24, node26ApexifyRuntimeConfigInputPublished type export ApexifyRuntimeConfigInput.
class · CURRENT · node22, node24, node26ApexPainterPrimary server-side rendering and media façade for the current Apexify.js package.
type · CURRENT · node22, node24, node26AssetKindPublished type export AssetKind.
interface · CURRENT · node22, node24, node26AssetRegistrationInfoPublished interface export AssetRegistrationInfo.
type · CURRENT · node22, node24, node26AssetResolveFnPublished type export AssetResolveFn.
type · CURRENT · node22, node24, node26AssetScalarPublished type export AssetScalar.
type · CURRENT · node22, node24, node26AssetValuePublished type export AssetValue.
type · CURRENT · node22, node24, node26AudioSeedProcedural audio synthesis — oscillators, noise, envelopes, presets, sequencing, composition, and PCM16 WAV I/O.
interface · CURRENT · node22, node24, node26AvatarToLayersOptionsPublished interface export AvatarToLayersOptions.
type · CURRENT · node22, node24, node26BackgroundImageAlignAlignment for {@link BackgroundLayer} image `contain` / `cover` (same as `customBg.align`).
type · CURRENT · node22, node24, node26BackgroundLayerPublished type export BackgroundLayer.
type · CURRENT · node22, node24, node26BackgroundPatternRepeatRepeat mode for tiled image patterns in {@link BackgroundLayer}.
interface · CURRENT · node22, node24, node26BadgeToLayersOptionsPublished interface export BadgeToLayersOptions.
interface · CURRENT · node22, node24, node26BaseRegionPublished interface export BaseRegion.
interface · CURRENT · node22, node24, node26BatchChainAssetOptsBatch/chain execution policy. Results preserve input order; failures are fail-fast.
interface · CURRENT · node22, node24, node26BatchChainPainterMinimal painter surface for batch / chain helpers.
type · CURRENT · node22, node24, node26BatchOperationPublished type export BatchOperation.
interface · CURRENT · node22, node24, node26BlendOptionsPublished interface export BlendOptions.
type · CURRENT · node22, node24, node26borderPositionPublished type export borderPosition.
interface · CURRENT · node22, node24, node26BoxBackgroundPublished interface export BoxBackground.
interface · CURRENT · node22, node24, node26CacheRuntimeConfigPublished interface export CacheRuntimeConfig.
interface · CURRENT · node22, node24, node26CanvasConfigPublished interface export CanvasConfig.
