engine
engine-core package
Classes
| Class | Description |
|---|---|
| [BaseHost](/engine/engine-core.basehost.html) | |
| [COM](/engine/engine-core.com.html) | |
| [Communication](/engine/engine-core.communication.html) | Manages all API registrations and message forwarding in each execution context. |
| [Config](/engine/engine-core.config.html) | |
| [ContextualEnvironment](/engine/engine-core.contextualenvironment.html) | |
| [Environment](/engine/engine-core.environment.html) | |
| [EnvironmentContext](/engine/engine-core.environmentcontext.html) | |
| [EnvironmentDisconnectedError](/engine/engine-core.environmentdisconnectederror.html) | |
| [EventEmitterHost](/engine/engine-core.eventemitterhost.html) | |
| [Feature](/engine/engine-core.feature.html) | |
| [FeatureLoadersRegistry](/engine/engine-core.featureloadersregistry.html) | |
| [LoggerService](/engine/engine-core.loggerservice.html) | |
| [MapRegistry](/engine/engine-core.mapregistry.html) | |
| [MapSlot](/engine/engine-core.mapslot.html) | |
| [MultiCounter](/engine/engine-core.multicounter.html) | |
| [OrderedRegistry](/engine/engine-core.orderedregistry.html) | |
| [OrderedSlot](/engine/engine-core.orderedslot.html) | |
| [Registry](/engine/engine-core.registry.html) | |
| [RuntimeConfigurations](/engine/engine-core.runtimeconfigurations.html) | Manage for the runtime configurations loading flow |
| [RuntimeEngine](/engine/engine-core.runtimeengine.html) | |
| [RuntimeFeature](/engine/engine-core.runtimefeature.html) | Represents a currently running feature instance. |
| [RuntimeMetadata](/engine/engine-core.runtimemetadata.html) | |
| [Service](/engine/engine-core.service.html) | |
| [Slot](/engine/engine-core.slot.html) | Set of user typed values, consumed at any flow that requires this feature. |
| [UniversalWorkerHost](/engine/engine-core.universalworkerhost.html) | |
| [Value](/engine/engine-core.value.html) | |
| [WindowInitializerService](/engine/engine-core.windowinitializerservice.html) | Service needed to complete window initialization |
| [WsClientHost](/engine/engine-core.wsclienthost.html) |
Abstract Classes
| Abstract Class | Description |
|---|---|
| [FeatureInput](/engine/engine-core.featureinput.html) | |
| [FeatureOutput](/engine/engine-core.featureoutput.html) |
Enumerations
| Enumeration | Description |
|---|---|
| [LogLevel](/engine/engine-core.loglevel.html) |
Functions
| Function | Description |
|---|---|
| [AUTO\_REGISTER\_ENVIRONMENT(message, hostId)](/engine/engine-core.auto_register_environment.html) | |
| [CALLBACK\_TIMEOUT(callbackId, hostId, message)](/engine/engine-core.callback_timeout.html) | |
| [createFeatureRuntime(FeatureClass, runningEngine)](/engine/engine-core.createfeatureruntime.html) | |
| [createRuntimeInfo()](/engine/engine-core.createruntimeinfo.html) | |
| [declareComEmitter(onMethod, offMethod, removeAll)](/engine/engine-core.declarecomemitter.html) | |
| [deferredIframeInitializer({ communication: com, env: { env, endpointType } })](/engine/engine-core.deferrediframeinitializer.html) | |
| [deserializeApiCallArguments(args)](/engine/engine-core.deserializeapicallarguments.html) | |
| [DOUBLE\_REGISTER\_ERROR(handlerId)](/engine/engine-core.double_register_error.html) | |
| [DUPLICATE\_REGISTER(id, type)](/engine/engine-core.duplicate_register.html) | |
| [ENV\_DISCONNECTED(environment, hostId)](/engine/engine-core.env_disconnected.html) | |
| [errorToJson(error)](/engine/engine-core.errortojson.html) | Converts a caught exception into a plain error-like object. The result is guaranteed to be free of circular references or properties that cannot be structurally cloned, and can be safely transferred via postMessage or WebSocket. |
| [flattenTree(root, children, predicate)](/engine/engine-core.flattentree.html) | |
| [FORWARDING\_MESSAGE\_STUCK\_IN\_CIRCULAR(message, fromEnv, toEnv)](/engine/engine-core.forwarding_message_stuck_in_circular.html) | |
| [FORWARDING\_MESSAGE(message, fromEnv, toEnv)](/engine/engine-core.forwarding_message.html) | |
| [getEngineEntryOptions(envName, globalObj)](/engine/engine-core.getengineentryoptions.html) | |
| [GLOBAL\_REF(id)](/engine/engine-core.global_ref.html) | |
| [iframeInitializer({ communication, env, ...initializerOptions })](/engine/engine-core.iframeinitializer.html) | |
| [initializeContextualEnv({ communication, env: { env, environments }, envInitializers, })](/engine/engine-core.initializecontextualenv.html) | |
| [injectScript(win, rootComId, scriptUrl)](/engine/engine-core.injectscript.html) | |
| [instantiateFeature(FeatureClass)](/engine/engine-core.instantiatefeature.html) | assume that feature is singleton we can run identity check on the api once |
| [ipcInitializer({ communication, env: { env, endpointType } })](/engine/engine-core.ipcinitializer.html) | |
| [isIframe(iframe)](/engine/engine-core.isiframe.html) | |
| [isMessage(arg)](/engine/engine-core.ismessage.html) | |
| [isWindow(win)](/engine/engine-core.iswindow.html) | |
| [isWorkerContext(target)](/engine/engine-core.isworkercontext.html) | |
| [main({ env, contextualConfig, publicConfigsRoute, featureLoaders, configLoaders, featureName, configName, options, })](/engine/engine-core.main.html) | main engine environment entry point flow This function is imported by the generated entry file and is the first function to initialize each environment |
| [MESSAGE\_FROM\_UNKNOWN\_ENVIRONMENT(message, hostId, origin)](/engine/engine-core.message_from_unknown_environment.html) | |
| [MISSING\_COM\_CONTEXT(id, when)](/engine/engine-core.missing_com_context.html) | |
| [MISSING\_CONTEXT\_FOR\_API\_PROXY(type, remoteServiceId)](/engine/engine-core.missing_context_for_api_proxy.html) | |
| [MISSING\_ENV(target, environments)](/engine/engine-core.missing_env.html) | |
| [MISSING\_FORWARD\_FOR\_MESSAGE(message)](/engine/engine-core.missing_forward_for_message.html) | |
| [multiTenantMethod(method)](/engine/engine-core.multitenantmethod.html) | |
| [normEnvVisibility(envVisibility, includeDependencies)](/engine/engine-core.normenvvisibility.html) | |
| [orderedEnvDependencies(env)](/engine/engine-core.orderedenvdependencies.html) | |
| [parseInjectRuntimeConfigConfig(options)](/engine/engine-core.parseinjectruntimeconfigconfig.html) | |
| [provideConfig(feature, config)](/engine/engine-core.provideconfig.html) | |
| [REGISTER\_ENV(id, hostId)](/engine/engine-core.register_env.html) | |
| [REMOTE\_CALL\_FAILED(environment, stack)](/engine/engine-core.remote_call_failed.html) | |
| [reportError\_2(e)](/engine/engine-core.reporterror_2.html) | |
| [returnsTrue()](/engine/engine-core.returnstrue.html) | |
| [run({ entryFeature, topLevelConfig, env, runOptions, })](/engine/engine-core.run.html) | |
| [runtimeType(name)](/engine/engine-core.runtimetype.html) | Just a Symbol that is used as any type T at runtime. |
| [serializeApiCallArguments(args)](/engine/engine-core.serializeapicallarguments.html) | Serialization/deserialization is needed in order to fix the issue with undefined arguments in remote API calls: https://github.com/wixplosives/engine/issues/1434 |
| [setup(feature, environment, setupHandler)](/engine/engine-core.setup.html) | |
| [setupContext(feature, \_environment, environmentContextKey, contextHandler)](/engine/engine-core.setupcontext.html) | |
| [socketClientInitializer({ communication, env: { env }, ...socketClientOptions })](/engine/engine-core.socketclientinitializer.html) | |
| [SPAWNED\_MORE\_THEN\_ONCE(id)](/engine/engine-core.spawned_more_then_once.html) | |
| [startIframe({ com, iframe, instanceId, src, envReadyPromise })](/engine/engine-core.startiframe.html) | |
| [UN\_CONFIGURED\_METHOD(api, method)](/engine/engine-core.un_configured_method.html) | |
| [UNHANDLED(message, hostId)](/engine/engine-core.unhandled.html) | |
| [UNKNOWN\_CALLBACK\_ID(message, hostId)](/engine/engine-core.unknown_callback_id.html) | |
| [validateNoDuplicateContextRegistration(environmentContext, featureId, contextHandlers)](/engine/engine-core.validatenoduplicatecontextregistration.html) | |
| [validateNoDuplicateEnvRegistration(env, featureId, registered)](/engine/engine-core.validatenoduplicateenvregistration.html) | |
| [webWorkerInitializer({ communication, env: { env, endpointType }, workerOptions, workerExtension, })](/engine/engine-core.webworkerinitializer.html) | |
| [windowInitializer({ communication, env: { env, endpointType }, host })](/engine/engine-core.windowinitializer.html) |
Interfaces
| Interface | Description |
|---|---|
| [ActiveEnvironment](/engine/engine-core.activeenvironment.html) | TODO: remove onReconnect and onDisconnect |
| [AnyServiceMethodOptions](/engine/engine-core.anyservicemethodoptions.html) | |
| [APIService](/engine/engine-core.apiservice.html) | |
| [BaseMessage](/engine/engine-core.basemessage.html) | |
| [CallbackMessage](/engine/engine-core.callbackmessage.html) | |
| [CallbackRecord](/engine/engine-core.callbackrecord.html) | |
| [CallMessage](/engine/engine-core.callmessage.html) | |
| [CommunicationOptions](/engine/engine-core.communicationoptions.html) | |
| [ConfigEnvironmentRecord](/engine/engine-core.configenvironmentrecord.html) | |
| [ConfigModule](/engine/engine-core.configmodule.html) | |
| [Configurable](/engine/engine-core.configurable.html) | |
| [Context](/engine/engine-core.context.html) | |
| [ContextualEnvironmentInitializerOptions](/engine/engine-core.contextualenvironmentinitializeroptions.html) | |
| [DisposeMessage](/engine/engine-core.disposemessage.html) | |
| [EngineerMetadataConfig](/engine/engine-core.engineermetadataconfig.html) | |
| [Entity](/engine/engine-core.entity.html) | |
| [EntityRecord](/engine/engine-core.entityrecord.html) | |
| [EnvironmentInstanceToken](/engine/engine-core.environmentinstancetoken.html) | |
| [EnvironmentRecord](/engine/engine-core.environmentrecord.html) | |
| [EventMessage](/engine/engine-core.eventmessage.html) | |
| [FeatureClass](/engine/engine-core.featureclass.html) | |
| [FeatureDescriptor](/engine/engine-core.featuredescriptor.html) | |
| [FoundFeatures](/engine/engine-core.foundfeatures.html) | |
| [IComConfig](/engine/engine-core.icomconfig.html) | |
| [IDTag](/engine/engine-core.idtag.html) | \*\*\*\*\*\*\*\*\*\*\*\*\* ENGINE TYPES \*\*\*\*\*\*\*\*\*\*\*\*\*\* |
| [IFeatureLoader](/engine/engine-core.ifeatureloader.html) | |
| [IframeInitializerOptions](/engine/engine-core.iframeinitializeroptions.html) | |
| [IIframeInitializerOptions](/engine/engine-core.iiframeinitializeroptions.html) | |
| [InitializerOptions](/engine/engine-core.initializeroptions.html) | |
| [IPreloadModule](/engine/engine-core.ipreloadmodule.html) | |
| [IRunEngineAppOptions](/engine/engine-core.irunengineappoptions.html) | |
| [IRunOptions](/engine/engine-core.irunoptions.html) | |
| [ListenMessage](/engine/engine-core.listenmessage.html) | |
| [LoggerTransport](/engine/engine-core.loggertransport.html) | |
| [LogMessage](/engine/engine-core.logmessage.html) | |
| [LogMetadata](/engine/engine-core.logmetadata.html) | |
| [LogValueData](/engine/engine-core.logvaluedata.html) | |
| [MainEntryParams](/engine/engine-core.mainentryparams.html) | |
| [ReadyMessage](/engine/engine-core.readymessage.html) | |
| [RemoteAPIServicesMapping](/engine/engine-core.remoteapiservicesmapping.html) | |
| [RemoteCallAddress](/engine/engine-core.remotecalladdress.html) | |
| [RunEngineOptions](/engine/engine-core.runengineoptions.html) | |
| [ServiceMethodOptions](/engine/engine-core.servicemethodoptions.html) | |
| [SocketClientInitializerOptions](/engine/engine-core.socketclientinitializeroptions.html) | |
| [StatusMessage](/engine/engine-core.statusmessage.html) | |
| [Target](/engine/engine-core.target.html) | |
| [UnListenMessage](/engine/engine-core.unlistenmessage.html) | |
| [WebWorkerInitializerOptions](/engine/engine-core.webworkerinitializeroptions.html) |
Variables
| Variable | Description |
|---|---|
| [AllEnvironments](/engine/engine-core.allenvironments.html) | |
| [CONFIGURABLE](/engine/engine-core.configurable.html) | |
| [CREATE\_RUNTIME](/engine/engine-core.create_runtime.html) | |
| [ENGINE](/engine/engine-core.engine.html) | |
| [globallyProvidingEnvironments](/engine/engine-core.globallyprovidingenvironments.html) | |
| [HOST\_REMOVED](/engine/engine-core.host_removed.html) | |
| [IDENTIFY\_API](/engine/engine-core.identify_api.html) | |
| [INSTANCE\_ID\_PARAM\_NAME](/engine/engine-core.instance_id_param_name.html) | |
| [REGISTER\_VALUE](/engine/engine-core.register_value.html) | |
| [RUN\_OPTIONS](/engine/engine-core.run_options.html) | |
| [RUN](/engine/engine-core.run.html) | |
| [SERVICE\_CONFIG](/engine/engine-core.service_config.html) | |
| [Universal](/engine/engine-core.universal.html) |
Type Aliases
| Type Alias | Description |
|---|---|
| [AnyEnvironment](/engine/engine-core.anyenvironment.html) | |
| [AnyFunction](/engine/engine-core.anyfunction.html) | |
| [AsyncApi](/engine/engine-core.asyncapi.html) | |
| [ConfigLoader](/engine/engine-core.configloader.html) | |
| [ConfigLoaders](/engine/engine-core.configloaders.html) | |
| [ContextHandler](/engine/engine-core.contexthandler.html) | |
| [DeepEnvDepsTuple](/engine/engine-core.deepenvdepstuple.html) | |
| [DeepEnvironmentDeps](/engine/engine-core.deepenvironmentdeps.html) | |
| [DeepEnvironmentNamesDeps](/engine/engine-core.deepenvironmentnamesdeps.html) | |
| [DisposeFunction](/engine/engine-core.disposefunction.html) | |
| [EntityDefModes](/engine/engine-core.entitydefmodes.html) | |
| [EnvironmentInitializer](/engine/engine-core.environmentinitializer.html) | |
| [EnvironmentInitializers](/engine/engine-core.environmentinitializers.html) | |
| [EnvironmentMode](/engine/engine-core.environmentmode.html) | |
| [EnvironmentTypes](/engine/engine-core.environmenttypes.html) | |
| [EnvType](/engine/engine-core.envtype.html) | |
| [EnvVisibility](/engine/engine-core.envvisibility.html) | |
| [FeatureDependencies](/engine/engine-core.featuredependencies.html) | |
| [FilterEnv](/engine/engine-core.filterenv.html) | |
| [FilterFirstArgument](/engine/engine-core.filterfirstargument.html) | |
| [FilterNotEnv](/engine/engine-core.filternotenv.html) | |
| [FilterNotENVKeys](/engine/engine-core.filternotenvkeys.html) | |
| [FilterRecord](/engine/engine-core.filterrecord.html) | |
| [Flatten](/engine/engine-core.flatten.html) | |
| [GetDependenciesOutput](/engine/engine-core.getdependenciesoutput.html) | |
| [GetInputs](/engine/engine-core.getinputs.html) | |
| [GetOnlyLocalUniversalOutputs](/engine/engine-core.getonlylocaluniversaloutputs.html) | |
| [GetOutputs](/engine/engine-core.getoutputs.html) | |
| [GetRemoteOutputs](/engine/engine-core.getremoteoutputs.html) | |
| [GloballyProvidingEnvironments](/engine/engine-core.globallyprovidingenvironments.html) | |
| [Json](/engine/engine-core.json.html) | |
| [LogValue](/engine/engine-core.logvalue.html) | |
| [MapAllTypesForEnv](/engine/engine-core.mapalltypesforenv.html) | |
| [MapBy](/engine/engine-core.mapby.html) | |
| [MapRecordType](/engine/engine-core.maprecordtype.html) | |
| [MapToPartialType](/engine/engine-core.maptopartialtype.html) | |
| [MapToProxyType](/engine/engine-core.maptoproxytype.html) | |
| [MapType](/engine/engine-core.maptype.html) | |
| [MapVisibleInputs](/engine/engine-core.mapvisibleinputs.html) | |
| [MergeConfigHook](/engine/engine-core.mergeconfighook.html) | |
| [Message](/engine/engine-core.message.html) | |
| [MultiEnvAsyncApi](/engine/engine-core.multienvasyncapi.html) | |
| [MultiEnvironment](/engine/engine-core.multienvironment.html) | |
| [MultiTanentProxyFunction](/engine/engine-core.multitanentproxyfunction.html) | |
| [OmitCompositeEnvironment](/engine/engine-core.omitcompositeenvironment.html) | |
| [PartialFeatureConfig](/engine/engine-core.partialfeatureconfig.html) | |
| [ReferencedEnvironments](/engine/engine-core.referencedenvironments.html) | |
| [RegisteringFeature](/engine/engine-core.registeringfeature.html) | |
| [Running](/engine/engine-core.running.html) | |
| [RunningFeatures](/engine/engine-core.runningfeatures.html) | |
| [RunningInstance](/engine/engine-core.runninginstance.html) | |
| [SerializableArguments](/engine/engine-core.serializablearguments.html) | |
| [SerializableMethod](/engine/engine-core.serializablemethod.html) | |
| [ServiceComConfig](/engine/engine-core.servicecomconfig.html) | |
| [ServiceConfig](/engine/engine-core.serviceconfig.html) | |
| [ServiceRuntime](/engine/engine-core.serviceruntime.html) | |
| [SettingUpFeature](/engine/engine-core.settingupfeature.html) | |
| [SettingUpFeatureBase](/engine/engine-core.settingupfeaturebase.html) | |
| [SetupHandler](/engine/engine-core.setuphandler.html) | |
| [SlotOrdering](/engine/engine-core.slotordering.html) | |
| [TopLevelConfig](/engine/engine-core.toplevelconfig.html) | |
| [UnknownFunction](/engine/engine-core.unknownfunction.html) | |
| [ValuePromise](/engine/engine-core.valuepromise.html) | |
| [WindowHost](/engine/engine-core.windowhost.html) |