engine
@wixc3/engine-runtime-node on Github
Home > @wixc3/engine-runtime-node
engine-runtime-node package
Classes
| Class | Description |
|---|---|
| [ChildBaseHost](/engine/engine-runtime-node.childbasehost.html) | |
| [ForkedProcess](/engine/engine-runtime-node.forkedprocess.html) | |
| [IPCHost](/engine/engine-runtime-node.ipchost.html) | |
| [NodeEnvironmentsManager](/engine/engine-runtime-node.nodeenvironmentsmanager.html) | |
| [NodeEnvManager](/engine/engine-runtime-node.nodeenvmanager.html) | |
| [ParentPortHost](/engine/engine-runtime-node.parentporthost.html) | |
| [WsHost](/engine/engine-runtime-node.wshost.html) | |
| [WsServerHost](/engine/engine-runtime-node.wsserverhost.html) |
Functions
| Function | Description |
|---|---|
| [bindMetricsListener(customFetcher)](/engine/engine-runtime-node.bindmetricslistener.html) | |
| [bindRpcListener(type, customFetcher)](/engine/engine-runtime-node.bindrpclistener.html) | |
| [createFeatureEnvironmentsMapping(features)](/engine/engine-runtime-node.createfeatureenvironmentsmapping.html) | This function generates a mapping from feature name to the environments it should run. |
| [createFeatureLoaders(features, { childEnvName, env })](/engine/engine-runtime-node.createfeatureloaders.html) | |
| [createIPC(remoteProcess, socketServer, { port, onClose })](/engine/engine-runtime-node.createipc.html) | |
| [createMetadataProvider(com)](/engine/engine-runtime-node.createmetadataprovider.html) | creates a new instance of metadata provider that can get application metadata using `MetadataCollectionAPI` api that should be registered for `ROOT_ENGINE_ENV_ID` environment |
| [createStaticFeatureDefinition(partial)](/engine/engine-runtime-node.createstaticfeaturedefinition.html) | |
| [dynamicImport(modulePath)](/engine/engine-runtime-node.dynamicimport.html) | |
| [getMetricsFromProcess(managerProcess, timeout)](/engine/engine-runtime-node.getmetricsfromprocess.html) | |
| [getMetricsFromWorker(worker)](/engine/engine-runtime-node.getmetricsfromworker.html) | |
| [getNextMessageId()](/engine/engine-runtime-node.getnextmessageid.html) | |
| [importModules(basePath, requiredModules)](/engine/engine-runtime-node.importmodules.html) | Dynamically imports required modules using the specified base path. |
| [isEnvironmentCloseMessage(message)](/engine/engine-runtime-node.isenvironmentclosemessage.html) | |
| [isEnvironmentMetricsRequestMessage(message)](/engine/engine-runtime-node.isenvironmentmetricsrequestmessage.html) | |
| [isEnvironmentMetricsResponseMessage(message)](/engine/engine-runtime-node.isenvironmentmetricsresponsemessage.html) | |
| [isEnvironmentPortMessage(message)](/engine/engine-runtime-node.isenvironmentportmessage.html) | |
| [isEnvironmentStartMessage(message)](/engine/engine-runtime-node.isenvironmentstartmessage.html) | |
| [isParentProcess(process)](/engine/engine-runtime-node.isparentprocess.html) | |
| [isProcessMessage(value)](/engine/engine-runtime-node.isprocessmessage.html) | |
| [isValidRpcMessage(message)](/engine/engine-runtime-node.isvalidrpcmessage.html) | |
| [isValidRpcResponse(responseMessage, id)](/engine/engine-runtime-node.isvalidrpcresponse.html) | |
| [kebabCaseToCamelCase(value)](/engine/engine-runtime-node.kebabcasetocamelcase.html) | |
| [launchEngineHttpServer({ staticDirPath, httpServerPort, socketServerOptions, routeMiddlewares, hostname, })](/engine/engine-runtime-node.launchenginehttpserver.html) | |
| [loadTopLevelConfigs(configName, configurations, envName)](/engine/engine-runtime-node.loadtoplevelconfigs.html) | |
| [localNodeEnvironmentInitializer({ communication: com, env })](/engine/engine-runtime-node.localnodeenvironmentinitializer.html) | when running the engine application, an active environment should be provided to this runtime, with the id [ENGINE\_ROOT\_ENVIRONMENT\_ID](/engine/engine-runtime-node.engine_root_environment_id.html) when running engine application using \[@wixc3/engineer\](../../engineer), it is done in the node environments manager |
| [localPerformanceFetcher()](/engine/engine-runtime-node.localperformancefetcher.html) | |
| [parseCliArguments(args)](/engine/engine-runtime-node.parsecliarguments.html) | |
| [parseRuntimeOptions()](/engine/engine-runtime-node.parseruntimeoptions.html) | |
| [readMetadataFiles(dir)](/engine/engine-runtime-node.readmetadatafiles.html) | |
| [resolveEnvironments(featureName, features, envTypes, filterByContext)](/engine/engine-runtime-node.resolveenvironments.html) | |
| [rpcCall(worker, type, timeout)](/engine/engine-runtime-node.rpccall.html) | |
| [runIPCEnvironment(options)](/engine/engine-runtime-node.runipcenvironment.html) | |
| [runNodeEnvironment({ featureName, childEnvName, features, bundlePath, config, name, type, options, host, env, })](/engine/engine-runtime-node.runnodeenvironment.html) | |
| [runWorker(instanceId, workerURL, runtimeOptions)](/engine/engine-runtime-node.runworker.html) | |
| [runWSEnvironment(socketServer, startEnvironmentOptions)](/engine/engine-runtime-node.runwsenvironment.html) | |
| [workerThreadInitializer({ communication, env, environmentStartupOptions, })](/engine/engine-runtime-node.workerthreadinitializer.html) | |
| [workerThreadInitializer2({ communication, env, workerURL, runtimeOptions, })](/engine/engine-runtime-node.workerthreadinitializer2.html) | |
| [writeMetaFiles(dir, featureEnvironmentsMapping, configMapping)](/engine/engine-runtime-node.writemetafiles.html) |
Interfaces
| Interface | Description |
|---|---|
| [ConfigurationEnvironmentMappingEntry](/engine/engine-runtime-node.configurationenvironmentmappingentry.html) | |
| [ICommunicationMessage](/engine/engine-runtime-node.icommunicationmessage.html) | |
| [IConfigDefinition](/engine/engine-runtime-node.iconfigdefinition.html) | |
| [ICreateCommunicationOptions](/engine/engine-runtime-node.icreatecommunicationoptions.html) | |
| [IEngineRuntimeArguments](/engine/engine-runtime-node.iengineruntimearguments.html) | |
| [IEnvironmentDescriptor](/engine/engine-runtime-node.ienvironmentdescriptor.html) | |
| [IEnvironmentMessage](/engine/engine-runtime-node.ienvironmentmessage.html) | |
| [IEnvironmentMetricsRequest](/engine/engine-runtime-node.ienvironmentmetricsrequest.html) | |
| [IEnvironmentMetricsResponse](/engine/engine-runtime-node.ienvironmentmetricsresponse.html) | |
| [IEnvironmentPortMessage](/engine/engine-runtime-node.ienvironmentportmessage.html) | |
| [IEnvironmentStartMessage](/engine/engine-runtime-node.ienvironmentstartmessage.html) | |
| [ILaunchEnvironmentOptions](/engine/engine-runtime-node.ilaunchenvironmentoptions.html) | |
| [ILaunchHttpServerOptions](/engine/engine-runtime-node.ilaunchhttpserveroptions.html) | |
| [INodeEnvironmentsManagerOptions](/engine/engine-runtime-node.inodeenvironmentsmanageroptions.html) | |
| [IProcessMessage](/engine/engine-runtime-node.iprocessmessage.html) | |
| [IRuntimeEnvironment](/engine/engine-runtime-node.iruntimeenvironment.html) | |
| [IStaticFeatureDefinition](/engine/engine-runtime-node.istaticfeaturedefinition.html) | |
| [MetadataCollectionAPI](/engine/engine-runtime-node.metadatacollectionapi.html) | |
| [NodeEnvironmentStartupOptions](/engine/engine-runtime-node.nodeenvironmentstartupoptions.html) | |
| [OverrideConfig](/engine/engine-runtime-node.overrideconfig.html) | |
| [RemoteProcess](/engine/engine-runtime-node.remoteprocess.html) | |
| [RouteMiddleware](/engine/engine-runtime-node.routemiddleware.html) | |
| [RunEnvironmentOptions](/engine/engine-runtime-node.runenvironmentoptions.html) | |
| [RunningEnvironment](/engine/engine-runtime-node.runningenvironment.html) | |
| [RunningNodeEnvironment](/engine/engine-runtime-node.runningnodeenvironment.html) | |
| [StartEnvironmentOptions](/engine/engine-runtime-node.startenvironmentoptions.html) | |
| [StartIPCEnvironmntOptions](/engine/engine-runtime-node.startipcenvironmntoptions.html) | |
| [WorkerThreadInitializer](/engine/engine-runtime-node.workerthreadinitializer.html) | |
| [WorkerThreadInitializer2](/engine/engine-runtime-node.workerthreadinitializer2.html) | |
| [WorkerThreadInitializerOptions2](/engine/engine-runtime-node.workerthreadinitializeroptions2.html) |
Variables
| Variable | Description |
|---|---|
| [DEFAULT\_PORT](/engine/engine-runtime-node.default_port.html) | |
| [ENGINE\_ROOT\_ENVIRONMENT\_ID](/engine/engine-runtime-node.engine_root_environment_id.html) | |
| [METADATA\_PROVIDER\_ENV\_ID](/engine/engine-runtime-node.metadata_provider_env_id.html) | |
| [metadataApiToken](/engine/engine-runtime-node.metadataapitoken.html) |
Type Aliases
| Type Alias | Description |
|---|---|
| [ConfigFilePath](/engine/engine-runtime-node.configfilepath.html) | |
| [ConfigurationEnvironmentMapping](/engine/engine-runtime-node.configurationenvironmentmapping.html) | |
| [FeatureEnvironmentMapping](/engine/engine-runtime-node.featureenvironmentmapping.html) | |
| [LaunchEnvironmentMode](/engine/engine-runtime-node.launchenvironmentmode.html) | |
| [PerformanceMetrics](/engine/engine-runtime-node.performancemetrics.html) | |
| [ProcessMessageId](/engine/engine-runtime-node.processmessageid.html) | |
| [RunningFeatureIdentification](/engine/engine-runtime-node.runningfeatureidentification.html) | |
| [TopLevelConfigProvider](/engine/engine-runtime-node.toplevelconfigprovider.html) | |
| [WorkerThreadCommand](/engine/engine-runtime-node.workerthreadcommand.html) | The command that is sent to 'worker\_thead'. |
| [WorkerThreadDisposeCommand](/engine/engine-runtime-node.workerthreaddisposecommand.html) | The command that is sent to 'worker\_thead' to start dispose process. |
| [WorkerThreadDisposedEvent](/engine/engine-runtime-node.workerthreaddisposedevent.html) | The event that is emitted from 'worker\_thead' when dispose is finished. |
| [WorkerThreadEnvironmentStartupOptions](/engine/engine-runtime-node.workerthreadenvironmentstartupoptions.html) | |
| [WorkerThreadEvent](/engine/engine-runtime-node.workerthreadevent.html) | The event that is emitted from 'worker\_thead'. |
| [WorkerThreadInitializerOptions](/engine/engine-runtime-node.workerthreadinitializeroptions.html) | |
| [WorkerThreadStartupCommand](/engine/engine-runtime-node.workerthreadstartupcommand.html) | The command that is sent to 'worker\_thead' to start environment initialization process. |