Interface EngineDefinition<TControllers, TEngineOptions, TSolutionType>

Deprecated

This method is deprecated and will be removed in a future major version. Use the fetchStaticState method instead.

Builds an engine and its controllers from an engine definition.

Deprecated

This method will be removed in a future major version. Prefer providing the access token directly when fetching the static state to avoid relying on the shared definition.

Returns the access token.

Deprecated

This method will be removed in a future major version. It mutates the shared engine definition, so on a server handling concurrent requests one request can overwrite another request's token. Provide the access token directly when fetching the static state, and pass the same token to hydrateStaticState(). To rotate the token of an engine that is already running, configure renewAccessToken on the engine configuration.

Deprecated

This method will be removed in a future major version. Navigator context should be provided directly when fetching the static state.

Sets the navigator context provider. This provider is essential for retrieving navigation-related data such as referrer, userAgent, location, and clientId, which are crucial for handling both server-side and client-side API requests effectively.

Note: The implementation specifics of the navigator context provider depend on the Node.js framework being utilized. It is the developer's responsibility to appropriately define and implement the navigator context provider to ensure accurate navigation context is available throughout the application. If the user fails to provide a navigator context provider, a warning will be logged either on the server or the browser console.