Skip to main content

@backstage/plugin-app-node

Home > @backstage/plugin-app-node

Node.js library for the app plugin.

Functions

FunctionDescription
loadCompiledConfigSchema(appDistDir)Loads the config schema that is embedded in the frontend build.

Interfaces

InterfaceDescription
ConfigSchemaExtensionPointThe interface for configSchemaExtensionPoint.
StaticFallbackHandlerExtensionPointThe interface for staticFallbackHandlerExtensionPoint.

Variables

VariableDescription
configSchemaExtensionPointAn extension point the exposes the ability to override the config schema used by the frontend application.
staticFallbackHandlerExtensionPoint

An extension point the exposes the ability to configure a static fallback handler for the app backend.

The static fallback handler is a request handler to handle requests for static content that is not present in the app bundle.

This can be used to avoid issues with clients on older deployment versions trying to access lazy loaded content that is no longer present. Typically the requests would fall back to a long-term object store where all recently deployed versions of the app are present.

Another option is to provide a database that will take care of storing the static assets instead.

If both database and staticFallbackHandler are provided, the database will attempt to serve static assets first, and if they are not found, the staticFallbackHandler will be called.