Skip to content

Latest commit

 

History

History

api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

@skypager/runtime API Docs

yarn add @skypager/runtime --save

Runtime

API Docs

You can subclass Runtime using the following

import runtime from '@skypager/runtime'

const { Runtime } = runtime

class MyRuntime extends Runtime {

}

Or you can just use the global singleton instance of Runtime that you get when you import a runtime module, and build upon that with different layers depending on which platform and environment your code is running in.

import runtime from '@skypager/runtime'
import sameObjectAsRuntimeButWithWebFeatures from '@skypager/web'
import sameObjectAsAboveButWithNodeFeatures from '@skypager/node' 

The global singleton instance of Runtime can be gradually built up in layers

a layer is a collection of the Helper and Feature classes

Helper

API Docs

Subclasses of Helper define roles, or patterns, for other modules in a project to conform to, so that your application can later use those modules in a specific way

For example @skypager/helpers-server defines a Server class which extends Helper.

This lets us package multiple different servers and start any one of them in the context of our current runtime.

To be usable, these packaged servers need to provide implementations of functions specified by the Server helper.

The Feature helper, which is documented below, lets us package any kind of functional interface as something that can be conditionally enabled() and configured with environment, process, URL or user specific settings.

Feature

API Docs

The Feature class subclasses Helper and is attach by default to any @skypager/runtime.

By default, the VM Feature and Profiler Feature are enabled.