@webruntime/framework-server

Lightning Web Runtime :: Core API

Not all projects are equal and definitely not all projects are turn-key. If you would like to run Lightning Web Runtime without the CLI, we expose some of our programmatic APIs available in Node.js. If you're looking for the CLI documentation you can find that here.

Context

Most operations require that a context be already established. The context says a lot about your application and since the compiler is stateless, you will have to establish a context before starting. The context-service provides you with 3 methods: startContext, getContext and endContext.

Usage

import { startContext } from '@webruntime/api';

await contextService.startContext(options);

try {
    // do something
} finally {
    contextService.endContext();
}

Reference

Context Service Documentation

Generators

TBD

Usage

Get all the resources for the current application:

import { routeService, resourceService } from '@webruntime/api';

const resources = routeService.getRoutesResources(routes, theme, locale, isDesignMode);
await Promise.all(
    resources.map(routeDescriptor => {
        return resourceService.get(routeDescriptor);
    })
);

Reference

Express Middlewares

TBD

Reference