cordis

Cordis

AOP Framework for Modern JavaScript Applications.

import { App } from 'cordis'

const app = new App()

app.plugin(plugin)              // use plugins
app.on(event, callback)         // listen to events

app.start()                     // start app

Concepts

App

Context

Contexts provide three kinds of functionality:

• allowing access to services (service container)
• managing states of plugins (plugin context)
• filtering sessions for events (session context)

Plugin

Service

Events

API

Context

ctx.extend(meta)

• meta: Partial<Context.Meta>
• returns: Context

Creates a new context. All properties of the new context are inherited from the current context, except for properties specified in meta which are overridden.

Lifecycle

ctx.lifecycle is a built-in service which provides event-related functionality. Most of its methods are also directly accessible in the context.

ctx.emit(event, ...param)

• event: string event name
• param: any[] event parameters
• returns: void

Trigger the event called event, calling all associated listeners synchronously at the same time, passing the supplied arguments to each.

ctx.parallel(event, ...param)

• event: string event name
• param: any[] event parameters
• returns: Promise<void>

Trigger the event called event, calling all associated listeners asynchronously at the same time, passing the supplied arguments to each.

ctx.bail(event, ...param)

• event: string event name
• param: any[] event parameters
• returns: any

Trigger the event called event, calling all associated listeners synchronously in the order they were registered, passing the supplied arguments to each.

If any listener returns a value other than false, null or undefined, that value is returned. If all listeners return false, null or undefined, an undefined is returned. In either case, subsequent listeners will not be called.

ctx.serial(event, ...param)

• event: string event name
• param: any[] event parameters
• returns: Promise<any>

Trigger the event called event, calling all associated listeners asynchronously in the order they were registered, passing the supplied arguments to each.

If any listener is fulfilled with a value other than false, null or undefined, the returned promise is fulfilled with that value. If all listeners are fulfilled with false, null or undefined, the returned promise is fulfilled with undefined. In either case, subsequent listeners will not be called.

ctx.on()

ctx.once()

ctx.off()

ctx.lifecycle.start()

ctx.lifecycle.stop()

ctx.lifecycle.mark()

ctx.lifecycle.register()

ctx.lifecycle.unregister()

Registry

ctx.registry is a built-in service which provides plugin-related functionality. It is actually a subclass of Map<Plugin, Runtime>, so you can access plugin runtime via methods like ctx.registry.get().

ctx.plugin()

ctx.using()

ctx.dispose()

State

State can be accessed via ctx.state or passed in in some events.

state.uid

• type: number

An auto-incrementing unique identifier for the state.

state.runtime

• type: Runtime

The plugin runtime associated with the state. If the state is a runtime, then this property refers to itself.

state.parent

state.context

state.config

state.restart()

state.update()

state.dispose()

Fork

Runtime

runtime.plugin

runtime.isForkable

Events

ready

dispose

fork

plugin-added

plugin-removed

internal/warn

internal/hook

internal/service

internal/update