Home > @xoram/core

core package

The heart of xoram.

View doc at https://xoram.dev.

Functions

Function	Description
addPlugin(definePlugin)	Register a plugin into the active application after it has been initialized.
addPlugin(definePlugin, app)	Register a plugin into the active application after it has been initialized.
addPlugins(definePlugins)	Register a set of plugins into the active application after it has been initialized.
addPlugins(definePlugins, app)	Register a set of plugins into the active application after it has been initialized.
addService(id, serviceFactory)	Register a service the depends on another or on the application.
addService(id, service)	Register a self-contained service with no dependency.
createApp(plugins, options)	Create an application from a set of plugins
defineAsyncPlugin(importer, when, dependencies)	Load a set of plugins in the application when a condition is met
definePlugin(setup)	Define an anonymous plugin using a generated id
definePlugin(name, setup)	Define a named plugin using a provided name.
defineService()	Define a stateless service, also known as Topic.
defineService(setup)	Define a stateful service.
dependsOn(dependency)	Mark the plugin as depending on the given dependency.
destroyApp(app)	Tear down an application and it's plugins
onBeforeCreate(callback)	Add a callback to be called between the dependency resolution and adding the plugins to the application
onBeforeDestroy(callback)	Add a callback to be called before the plugin is removed from the application
onCreated(callback)	Add a callback to be called when the plugin is added to the application
onEvent(target, on, handler)	Listen to multiple events from the same source at once and cleanly stop to listen when the plugin is disposed off.
onEvent(target, on, handler)	Listen to all the events of a source at once and cleanly stop to listen when the plugin is disposed off. Only use this overload when you need to listen to all the events, if you need to listen to just a subset of the events consider passing an array of those events.
onEvent(target, on, handler)	Listen to a specific event of a source and cleanly stop to listen when the plugin is disposed of.
removePlugin(idOrPlugin)	Remove a plugin and all those depending on it in reverse topological order.
removePlugin(idOrPlugin, app)	Remove a plugin and all those depending on it in reverse topological order.
useService(serviceId)	(BETA)

Interfaces

Interface	Description
Application	An application instance as returned by `createApp`.
ApplicationOptions	Optional configuration options for an application.
DefinedPlugin	An instance of a plugin as returned by a `PluginDefinition`.
PluginDefinition	A factory function that returns a defined plugin ready to be added to an application. Created by calling definePlugin(setup) or definePlugin(id, setup)
Service	The minimal requirement for a service. A service matching this interface precisely (i.e. without any other public member) is referred to as a Topic.
ServiceCollection	Register your service in this interface by augmenting it
ServiceNotifications	Events that all `services` are subject to emit.

Type Aliases

Type Alias	Description
ApplicationHooks	Event's emitted by the Application's own event emitter.
ApplicationPluginHooks	Plugin related hooks emitted by the application.
ApplicationPluginLifeCycleEvent	The payload of an event emitted by the application as part of a plugin's life cycle.
ApplicationServiceHooks	Service related hooks emitted by the application.
EventCleanup	An idempotent cleanup function returned by onEvent. It allows you to remove any listener setup by the onEvent call before the plugin's teardown phase.
EventSource_2	A direct emitter.
EventSourceContainer	An object holding an emitter, usually an application instance or service instance
EventSourceGetter	A function returning a direct emitter or an object holding an emitter. The application passed as parameter is the current application context onEvent is called as part of.
EventTarget_2
MergedEvents
Notifications
NotificationsFromService
OneOrMore
PluginId	A plugin's unique identifier. ⚠️ Do not mistake this with definePlugin name parameter.
PluginSetup	Describes how a plugin is created.
Prettify	Prettify types. Shamelessly stolen from https://timdeschryver.dev/bits/pretty-typescript-types
ServiceFactory	Build and return a service object, the provided app can be used to access already registered services or to listen to ApplicationHooks.
ServiceId
UnionToIntersection